Roflin/gamenight
1
0
Fork 2
Code Issues Pull Requests Projects Releases Wiki Activity
Files
ea9ad8033680f4f084fb7d6434fcacfea7066ab6
gamenight/gamenight-api-client-rs/docs/DefaultApi.md

740 lines
20 KiB
Markdown
Raw Blame History

# \DefaultApi
All URIs are relative to *http://localhost:8080*
Method | HTTP request | Description
------------- | ------------- | -------------
[**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
[**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 |
[**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 |
## game_game_id_delete
> game_game_id_delete(game_id, game_id2)
Delete this game.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | **String** | Uuid of game to delete. | [required] |
**game_id2** | 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_game_id_get
> models::Game game_game_id_get(game_id)
Get this specific game
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**game_id** | **String** | Uuid of game to get. | [required] |
### Return type
[**models::Game**](Game.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)
## 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_game_id_put
> 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
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**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
(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
[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)
## games_get
> Vec<models::Game> games_get()
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::Game>**](Game.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)
## games_post
> models::GameId games_post(add_game_request_body)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**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
[**models::Gamenight**](Gamenight.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)
## get_gamenights
> Vec<models::Gamenight> get_gamenights()
Get a all gamenights
Retrieve the list of gamenights on this gamenight server. Requires authorization.
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::Gamenight>**](Gamenight.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)
## location_location_id_authorized_users_get
> Vec<models::UserId> location_location_id_authorized_users_get(location_id)
gets this locations authorized users
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**location_id** | **String** | Uuid of location to get authorized users for. | [required] |
### Return type
[**Vec<models::UserId>**](UserId.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)
## 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
------------- | ------------- | ------------- | ------------- | -------------
**location_id** | **String** | Uuid location to authorize for. | [required] |
**user_id** | Option<[**UserId**](UserId.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_location_id_authorized_users_user_id_delete
> location_location_id_authorized_users_user_id_delete(location_id, user_id)
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**location_id** | **String** | Uuid of location to deauthorize for. | [required] |
**user_id** | **String** | Uuid of user ot deauthorize. | [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)
## location_location_id_get
> models::Location location_location_id_get(location_id)
gets this location
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**location_id** | **String** | Uuid of location to get. | [required] |
### Return type
[**models::Location**](Location.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)
## locations_get
> Vec<models::Location> locations_get()
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::Location>**](Location.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)
## locations_post
> models::LocationId locations_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
- **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_gamenight
> post_gamenight(add_gamenight_request_body)
Add a gamenight by providing a name and a date, only available when providing an JWT token.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**add_gamenight_request_body** | Option<[**AddGamenightRequestBody**](AddGamenightRequestBody.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)
## post_refresh_tokenz
> 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.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**registration** | Option<[**Registration**](Registration.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)
## user_user_id_get
> models::User user_user_id_get(user_id)
Get a user from primary id
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | Uuid of user to get | [required] |
### Return type
[**models::User**](User.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)
## 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
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **String** | Uuid of user to get owned games for. | [required] |
### Return type
[**Vec<models::OwnedGame>**](OwnedGame.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)
## users_get
> Vec<models::User> users_get()
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::User>**](User.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)
Reference in New Issue View Git Blame Copy Permalink