4.1 KiB
\DefaultApi
All URIs are relative to http://localhost:8080
Method | HTTP request | Description |
---|---|---|
get_gamenight | GET /gamenight | |
get_gamenights | GET /gamenights | Your GET endpoint |
get_token | GET /token | |
post_gamenight | POST /gamenight | |
post_register | POST /user |
get_gamenight
models::Gamenight get_gamenight(get_gamenight_request)
Parameters
Name | Type | Description | Required | Notes |
---|---|---|---|---|
get_gamenight_request | Option<GetGamenightRequest> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_gamenights
Vecmodels::Gamenight get_gamenights() Your GET endpoint
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, application/xml
[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, application/xml
[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, application/xml
[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
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json, application/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]