Roflin/gamenight
1
0
Fork 2
Code Issues Pull Requests Projects Releases Wiki Activity

Converted the Api to a Restful api.

Browse Source
This commit is contained in:
Dennis Brentjes
2026-01-22 22:51:03 +01:00
parent 79ba1e1b44
commit ea9ad80336
34 changed files with 1779 additions and 1497 deletions
Download Patch File Download Diff File Expand all files Collapse all files

584
gamenight-api-client-rs/docs/DefaultApi.md
View File

@@ -4,72 +4,46 @@ All URIs are relative to *http://localhost:8080*
Method | HTTP request | Description
------------- | ------------- | -------------
[**authorized_location_user_ids_get**](DefaultApi.md#authorized_location_user_ids_get) | **GET** /authorized_location_user_ids |
[**disown_post**](DefaultApi.md#disown_post) | **POST** /disown |
[**game_delete**](DefaultApi.md#game_delete) | **DELETE** /game |
[**game_get**](DefaultApi.md#game_get) | **GET** /game |
[**game_post**](DefaultApi.md#game_post) | **POST** /game |
[**game_game_id_delete**](DefaultApi.md#game_game_id_delete) | **DELETE** /game/{gameId} | Delete this game.
[**game_game_id_get**](DefaultApi.md#game_game_id_get) | **GET** /game/{gameId} | Get this specific game
[**game_game_id_owner_user_id_delete**](DefaultApi.md#game_game_id_owner_user_id_delete) | **DELETE** /game/{gameId}/owner/{userId} | Own this game
[**game_game_id_owners_post**](DefaultApi.md#game_game_id_owners_post) | **POST** /game/{gameId}/owners | Own this game
[**game_game_id_put**](DefaultApi.md#game_game_id_put) | **PUT** /game/{gameId} | Changes this game resource
[**gamenight_gamenight_id_participant_user_id_delete**](DefaultApi.md#gamenight_gamenight_id_participant_user_id_delete) | **DELETE** /gamenight/{gamenightId}/participant/{userId} |
[**gamenight_gamenight_id_participants_get**](DefaultApi.md#gamenight_gamenight_id_participants_get) | **GET** /gamenight/{gamenightId}/participants | Get all participants for a gamenight
[**gamenight_gamenight_id_participants_post**](DefaultApi.md#gamenight_gamenight_id_participants_post) | **POST** /gamenight/{gamenightId}/participants | Add a participant
[**games_get**](DefaultApi.md#games_get) | **GET** /games |
[**games_post**](DefaultApi.md#games_post) | **POST** /games |
[**get_gamenight**](DefaultApi.md#get_gamenight) | **GET** /gamenight |
[**get_gamenights**](DefaultApi.md#get_gamenights) | **GET** /gamenights | Get a all gamenights
[**get_token**](DefaultApi.md#get_token) | **GET** /token |
[**join_post**](DefaultApi.md#join_post) | **POST** /join |
[**leave_post**](DefaultApi.md#leave_post) | **POST** /leave |
[**location_authorize_post**](DefaultApi.md#location_authorize_post) | **POST** /location_authorize |
[**location_get**](DefaultApi.md#location_get) | **GET** /location |
[**location_post**](DefaultApi.md#location_post) | **POST** /location |
[**location_location_id_authorized_users_get**](DefaultApi.md#location_location_id_authorized_users_get) | **GET** /location/{locationId}/authorized_users/ | gets this locations authorized users
[**location_location_id_authorized_users_post**](DefaultApi.md#location_location_id_authorized_users_post) | **POST** /location/{locationId}/authorized_users/ | Authorize a user
[**location_location_id_authorized_users_user_id_delete**](DefaultApi.md#location_location_id_authorized_users_user_id_delete) | **DELETE** /location/{locationId}/authorized_users/{userId} |
[**location_location_id_get**](DefaultApi.md#location_location_id_get) | **GET** /location/{locationId} | gets this location
[**locations_get**](DefaultApi.md#locations_get) | **GET** /locations |
[**own_post**](DefaultApi.md#own_post) | **POST** /own |
[**owned_games_get**](DefaultApi.md#owned_games_get) | **GET** /owned_games |
[**participants_get**](DefaultApi.md#participants_get) | **GET** /participants | Get all participants for a gamenight
[**post_gamenight**](DefaultApi.md#post_gamenight) | **POST** /gamenight |
[**post_register**](DefaultApi.md#post_register) | **POST** /user |
[**post_token**](DefaultApi.md#post_token) | **POST** /token |
[**rename_game_post**](DefaultApi.md#rename_game_post) | **POST** /rename_game |
[**user_get**](DefaultApi.md#user_get) | **GET** /user |
[**locations_post**](DefaultApi.md#locations_post) | **POST** /locations |
[**post_gamenight**](DefaultApi.md#post_gamenight) | **POST** /gamenights |
[**post_refresh_tokenz**](DefaultApi.md#post_refresh_tokenz) | **POST** /refresh_token | Refresh a user token
[**post_token**](DefaultApi.md#post_token) | **POST** /token | Login a user.
[**post_user**](DefaultApi.md#post_user) | **POST** /users | Registers a user into gamenight.
[**user_user_id_get**](DefaultApi.md#user_user_id_get) | **GET** /user/{userId} |
[**user_user_id_owned_games_get**](DefaultApi.md#user_user_id_owned_games_get) | **GET** /user/{userId}/owned_games | Get owned games of user
[**users_get**](DefaultApi.md#users_get) | **GET** /users |
## authorized_location_user_ids_get
> Vec<models::UserId> authorized_location_user_ids_get(location_id)
## game_game_id_delete
> game_game_id_delete(game_id, game_id2)
Delete this game.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**location_id** | Option<[**LocationId**](LocationId.md)> | | |
### Return type
[**Vec<models::UserId>**](UserId.md)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## disown_post
> disown_post(game_id)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | Option<[**GameId**](GameId.md)> | | |
**game_id** | **String** | Uuid of game to delete. | [required] |
**game_id2** | Option<[**GameId**](GameId.md)> | | |
### Return type
@@ -87,45 +61,17 @@ Name | Type | Description | Required | Notes
[[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)
## game_delete
> game_delete(game_id)
## game_game_id_get
> models::Game game_game_id_get(game_id)
Get this specific game
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | Option<[**GameId**](GameId.md)> | | |
### Return type
(empty response body)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## game_get
> models::Game game_get(game_id)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | Option<[**GameId**](GameId.md)> | | |
**game_id** | **String** | Uuid of game to get. | [required] |
### Return type
@@ -137,15 +83,102 @@ Name | Type | Description | Required | Notes
### 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)
## game_game_id_owner_user_id_delete
> game_game_id_owner_user_id_delete(game_id, user_id)
Own this game
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | **String** | Uuid of game that user no longer owns. | [required] |
**user_id** | **String** | Uuid of user that no longer owns. | [required] |
### Return type
(empty response body)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## game_game_id_owners_post
> game_game_id_owners_post(game_id, own_game)
Own this game
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | **String** | Uuid of game to own. | [required] |
**own_game** | Option<[**OwnGame**](OwnGame.md)> | | |
### Return type
(empty response body)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## game_post
## game_game_id_put
> models::GameId game_post(add_game_request_body)
> game_game_id_put(game_id, edit_game_request_body)
Changes this game resource
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | **String** | Uuid of game to change. | [required] |
**edit_game_request_body** | Option<[**EditGameRequestBody**](EditGameRequestBody.md)> | | |
### Return type
(empty response body)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## gamenight_gamenight_id_participant_user_id_delete
> gamenight_gamenight_id_participant_user_id_delete(gamenight_id, user_id, gamenight_id2)
### Parameters
@@ -153,11 +186,73 @@ Name | Type | Description | Required | Notes
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**add_game_request_body** | Option<[**AddGameRequestBody**](AddGameRequestBody.md)> | | |
**gamenight_id** | **String** | Uuid of gamenight to delete participant for | [required] |
**user_id** | **String** | Uuid of the of the participant to remove | [required] |
**gamenight_id2** | Option<[**GamenightId**](GamenightId.md)> | | |
### Return type
[**models::GameId**](GameId.md)
(empty response body)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## gamenight_gamenight_id_participants_get
> models::Participants gamenight_gamenight_id_participants_get(gamenight_id, gamenight_id2)
Get all participants for a gamenight
Retrieve the participants of a single gamenight by id.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**gamenight_id** | **String** | Uuid of gamenight to get participants for. | [required] |
**gamenight_id2** | Option<[**GamenightId**](GamenightId.md)> | | |
### Return type
[**models::Participants**](Participants.md)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## gamenight_gamenight_id_participants_post
> gamenight_gamenight_id_participants_post(gamenight_id, user_id)
Add a participant
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**gamenight_id** | **String** | Uuid of gamenight to add participants for. | [required] |
**user_id** | Option<[**UserId**](UserId.md)> | | |
### Return type
(empty response body)
### Authorization
@@ -196,9 +291,9 @@ This endpoint does not need any parameter.
[[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)
## get_gamenight
## games_post
> models::Gamenight get_gamenight(get_gamenight_request_body)
> models::GameId games_post(add_game_request_body)
### Parameters
@@ -206,7 +301,32 @@ This endpoint does not need any parameter.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_gamenight_request_body** | Option<[**GetGamenightRequestBody**](GetGamenightRequestBody.md)> | | |
**add_game_request_body** | Option<[**AddGameRequestBody**](AddGameRequestBody.md)> | | |
### Return type
[**models::GameId**](GameId.md)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## get_gamenight
> models::Gamenight get_gamenight()
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -218,7 +338,7 @@ Name | Type | Description | Required | Notes
### HTTP request headers
- **Content-Type**: application/json
- **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)
@@ -251,47 +371,46 @@ This endpoint does not need any parameter.
[[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)
## get_token
## location_location_id_authorized_users_get
> models::Token get_token(login)
Submit your credentials to get a JWT-token to use with the rest of the api.
> Vec<models::UserId> location_location_id_authorized_users_get(location_id)
gets this locations authorized users
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**login** | Option<[**Login**](Login.md)> | | |
**location_id** | **String** | Uuid of location to get authorized users for. | [required] |
### Return type
[**models::Token**](Token.md)
[**Vec<models::UserId>**](UserId.md)
### Authorization
No authorization required
[JWT-Auth](../README.md#JWT-Auth)
### HTTP request headers
- **Content-Type**: application/json
- **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)
## join_post
> join_post(gamenight_id)
## location_location_id_authorized_users_post
> location_location_id_authorized_users_post(location_id, user_id)
Authorize a user
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**gamenight_id** | Option<[**GamenightId**](GamenightId.md)> | | |
**location_id** | **String** | Uuid location to authorize for. | [required] |
**user_id** | Option<[**UserId**](UserId.md)> | | |
### Return type
@@ -309,9 +428,9 @@ Name | Type | Description | Required | Notes
[[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)
## leave_post
## location_location_id_authorized_users_user_id_delete
> leave_post(gamenight_id)
> location_location_id_authorized_users_user_id_delete(location_id, user_id)
### Parameters
@@ -319,7 +438,8 @@ Name | Type | Description | Required | Notes
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**gamenight_id** | Option<[**GamenightId**](GamenightId.md)> | | |
**location_id** | **String** | Uuid of location to deauthorize for. | [required] |
**user_id** | **String** | Uuid of user ot deauthorize. | [required] |
### Return type
@@ -331,51 +451,23 @@ Name | Type | Description | Required | Notes
### HTTP request headers
- **Content-Type**: application/json
- **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)
## location_authorize_post
> location_authorize_post(authorize_location_request_body)
## location_location_id_get
> models::Location location_location_id_get(location_id)
gets this location
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**authorize_location_request_body** | Option<[**AuthorizeLocationRequestBody**](AuthorizeLocationRequestBody.md)> | | |
### Return type
(empty response body)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## location_get
> models::Location location_get(location_id)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**location_id** | Option<[**LocationId**](LocationId.md)> | | |
**location_id** | **String** | Uuid of location to get. | [required] |
### Return type
@@ -387,35 +479,7 @@ Name | Type | Description | Required | Notes
### 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)
## location_post
> models::LocationId location_post(add_location_request_body)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**add_location_request_body** | Option<[**AddLocationRequestBody**](AddLocationRequestBody.md)> | | |
### Return type
[**models::LocationId**](LocationId.md)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### HTTP request headers
- **Content-Type**: application/json
- **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)
@@ -446,9 +510,9 @@ This endpoint does not need any parameter.
[[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)
## own_post
## locations_post
> own_post(own_game_request_body)
> models::LocationId locations_post(add_location_request_body)
### Parameters
@@ -456,69 +520,11 @@ This endpoint does not need any parameter.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**own_game_request_body** | Option<[**OwnGameRequestBody**](OwnGameRequestBody.md)> | | |
**add_location_request_body** | Option<[**AddLocationRequestBody**](AddLocationRequestBody.md)> | | |
### Return type
(empty response body)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## owned_games_get
> Vec<models::OwnedGame> owned_games_get(user_id)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | Option<[**UserId**](UserId.md)> | | |
### Return type
[**Vec<models::OwnedGame>**](OwnedGame.md)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## participants_get
> models::Participants participants_get(gamenight_id)
Get all participants for a gamenight
Retrieve the participants of a single gamenight by id.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**gamenight_id** | Option<[**GamenightId**](GamenightId.md)> | | |
### Return type
[**models::Participants**](Participants.md)
[**models::LocationId**](LocationId.md)
### Authorization
@@ -562,10 +568,67 @@ Name | Type | Description | Required | Notes
[[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)
## post_register
## post_refresh_tokenz
> post_register(registration)
> models::Token post_refresh_tokenz()
Refresh a user token
Refresh your JWT-token without logging in again.
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::Token**](Token.md)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### 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)
## post_token
> models::Token post_token(login)
Login a user.
Submit your credentials to get a JWT-token to use with the rest of the api.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**login** | Option<[**Login**](Login.md)> | | |
### Return type
[**models::Token**](Token.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)
## post_user
> post_user(registration)
Registers a user into gamenight.
Create a new user given a registration token and user information, username and email must be unique, and password and password_repeat must match.
@@ -592,20 +655,23 @@ Name | Type | Description | Required | Notes
[[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)
## post_token
## user_user_id_get
> models::Token post_token()
> models::User user_user_id_get(user_id)
Refresh your JWT-token without logging in again.
Get a user from primary id
### Parameters
This endpoint does not need any parameter.
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | Uuid of user to get | [required] |
### Return type
[**models::Token**](Token.md)
[**models::User**](User.md)
### Authorization
@@ -619,21 +685,21 @@ This endpoint does not need any parameter.
[[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)
## rename_game_post
> rename_game_post(rename_game_request_body)
## user_user_id_owned_games_get
> Vec<models::OwnedGame> user_user_id_owned_games_get(user_id)
Get owned games of user
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**rename_game_request_body** | Option<[**RenameGameRequestBody**](RenameGameRequestBody.md)> | | |
**user_id** | **String** | Uuid of user to get owned games for. | [required] |
### Return type
(empty response body)
[**Vec<models::OwnedGame>**](OwnedGame.md)
### Authorization
@@ -641,37 +707,7 @@ Name | Type | Description | Required | Notes
### 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_get
> models::User user_get(user_id)
Get a user from primary id
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | Option<[**UserId**](UserId.md)> | | |
### Return type
[**models::User**](User.md)
### Authorization
[JWT-Auth](../README.md#JWT-Auth)
### HTTP request headers
- **Content-Type**: application/json
- **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)