16 KiB
\DefaultApi
All URIs are relative to http://localhost:8080
| Method | HTTP request | Description |
|---|---|---|
| authorized_location_user_ids_get | GET /authorized_location_user_ids | |
| disown_post | POST /disown | |
| game_get | GET /game | |
| game_post | POST /game | |
| games_get | GET /games | |
| get_gamenight | GET /gamenight | |
| get_gamenights | GET /gamenights | Get a all gamenights |
| get_token | GET /token | |
| join_post | POST /join | |
| leave_post | POST /leave | |
| location_authorize_post | POST /location_authorize | |
| location_get | GET /location | |
| location_post | POST /location | |
| locations_get | GET /locations | |
| own_post | POST /own | |
| owned_games_get | GET /owned_games | |
| participants_get | GET /participants | Get all participants for a gamenight |
| post_gamenight | POST /gamenight | |
| post_register | POST /user | |
| post_token | POST /token | |
| rename_game_post | POST /rename_game | |
| user_get | GET /user | |
| users_get | GET /users |
authorized_location_user_ids_get
Vecmodels::UserId authorized_location_user_ids_get(location_id)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| location_id | Option<LocationId> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
disown_post
disown_post(game_id)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| game_id | Option<GameId> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
game_get
models::Game game_get(game_id)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| game_id | Option<GameId> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
game_post
models::GameId game_post(add_game_request_body)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| add_game_request_body | Option<AddGameRequestBody> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
games_get
Vecmodels::Game games_get()
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_gamenight
models::Gamenight get_gamenight(get_gamenight_request_body)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| get_gamenight_request_body | Option<GetGamenightRequestBody> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_gamenights
Vecmodels::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
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_token
models::Token get_token(login)
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> |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
join_post
join_post(gamenight_id)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| gamenight_id | Option<GamenightId> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
leave_post
leave_post(gamenight_id)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| gamenight_id | Option<GamenightId> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
location_authorize_post
location_authorize_post(authorize_location_request_body)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| authorize_location_request_body | Option<AuthorizeLocationRequestBody> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
location_get
models::Location location_get(location_id)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| location_id | Option<LocationId> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
location_post
models::LocationId location_post(add_location_request_body)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| add_location_request_body | Option<AddLocationRequestBody> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
locations_get
Vecmodels::Location locations_get()
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
own_post
own_post(own_game_request_body)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| own_game_request_body | Option<OwnGameRequestBody> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
owned_games_get
Vec owned_games_get(user_id)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | Option<UserId> |
Return type
Vec
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
post_register
post_register(registration)
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> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
post_token
models::Token post_token()
Refresh your JWT-token without logging in again.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
rename_game_post
rename_game_post(rename_game_request_body)
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| rename_game_request_body | Option<RenameGameRequestBody> |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
user_get
models::User user_get(user_id)
Get a user from primary id
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | Option<UserId> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
users_get
Vecmodels::User users_get()
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]