90 lines
5.0 KiB
Markdown
90 lines
5.0 KiB
Markdown
# Rust API client for gamenight-api-client-rs
|
|
|
|
Api specification for a Gamenight server
|
|
|
|
For more information, please visit [https://brentj.es](https://brentj.es)
|
|
|
|
## Overview
|
|
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 1.0
|
|
- Package version: 0.1.0
|
|
- Generator version: 7.18.0
|
|
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
|
|
|
|
## Installation
|
|
|
|
Put the package under your project folder in a directory named `gamenight-api-client-rs` and add the following to `Cargo.toml` under `[dependencies]`:
|
|
|
|
```
|
|
gamenight-api-client-rs = { path = "./gamenight-api-client-rs" }
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost:8080*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*DefaultApi* | [**delete_game**](docs/DefaultApi.md#delete_game) | **DELETE** /game/{gameId} | Delete this game.
|
|
*DefaultApi* | [**delete_game_owner**](docs/DefaultApi.md#delete_game_owner) | **DELETE** /game/{gameId}/owner/{userId} | no longer own this game
|
|
*DefaultApi* | [**delete_gamenight_participant**](docs/DefaultApi.md#delete_gamenight_participant) | **DELETE** /gamenight/{gamenightId}/participant/{userId} | deletes a gamenight participant
|
|
*DefaultApi* | [**delete_location_authorized_user**](docs/DefaultApi.md#delete_location_authorized_user) | **DELETE** /location/{locationId}/authorized_user/{userId} | remove an authorized user from a location
|
|
*DefaultApi* | [**get_game**](docs/DefaultApi.md#get_game) | **GET** /game/{gameId} | Get this specific game
|
|
*DefaultApi* | [**get_gamenight**](docs/DefaultApi.md#get_gamenight) | **GET** /gamenight/{gamenightId} | get the specified gamenight
|
|
*DefaultApi* | [**get_gamenight_participants**](docs/DefaultApi.md#get_gamenight_participants) | **GET** /gamenight/{gamenightId}/participants | Get all participants for a gamenight
|
|
*DefaultApi* | [**get_gamenights**](docs/DefaultApi.md#get_gamenights) | **GET** /gamenights | Get a all gamenights
|
|
*DefaultApi* | [**get_games**](docs/DefaultApi.md#get_games) | **GET** /games | get all games
|
|
*DefaultApi* | [**get_location**](docs/DefaultApi.md#get_location) | **GET** /location/{locationId} | gets this location
|
|
*DefaultApi* | [**get_location_authorized_users**](docs/DefaultApi.md#get_location_authorized_users) | **GET** /location/{locationId}/authorized_users/ | gets this locations authorized users
|
|
*DefaultApi* | [**get_locations**](docs/DefaultApi.md#get_locations) | **GET** /locations | get all locations
|
|
*DefaultApi* | [**get_user**](docs/DefaultApi.md#get_user) | **GET** /user/{userId} |
|
|
*DefaultApi* | [**get_user_owned_games**](docs/DefaultApi.md#get_user_owned_games) | **GET** /user/{userId}/owned_games | Get owned games of user
|
|
*DefaultApi* | [**get_users**](docs/DefaultApi.md#get_users) | **GET** /users | Get all users
|
|
*DefaultApi* | [**post_game_owners**](docs/DefaultApi.md#post_game_owners) | **POST** /game/{gameId}/owners | Own this game
|
|
*DefaultApi* | [**post_gamenight_participants**](docs/DefaultApi.md#post_gamenight_participants) | **POST** /gamenight/{gamenightId}/participants | Add a participant
|
|
*DefaultApi* | [**post_gamenights**](docs/DefaultApi.md#post_gamenights) | **POST** /gamenights | Gets the gamenight
|
|
*DefaultApi* | [**post_games**](docs/DefaultApi.md#post_games) | **POST** /games | add a game
|
|
*DefaultApi* | [**post_location_authorized_users**](docs/DefaultApi.md#post_location_authorized_users) | **POST** /location/{locationId}/authorized_users/ | Authorize a user
|
|
*DefaultApi* | [**post_locations**](docs/DefaultApi.md#post_locations) | **POST** /locations | add a location
|
|
*DefaultApi* | [**post_refresh_token**](docs/DefaultApi.md#post_refresh_token) | **POST** /refresh_token | Refresh a user token
|
|
*DefaultApi* | [**post_token**](docs/DefaultApi.md#post_token) | **POST** /token | Login a user.
|
|
*DefaultApi* | [**post_users**](docs/DefaultApi.md#post_users) | **POST** /users | Registers a user into gamenight.
|
|
*DefaultApi* | [**put_game**](docs/DefaultApi.md#put_game) | **PUT** /game/{gameId} | Changes this game resource
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [AddGameRequestBody](docs/AddGameRequestBody.md)
|
|
- [AddGamenightRequestBody](docs/AddGamenightRequestBody.md)
|
|
- [AddLocationRequestBody](docs/AddLocationRequestBody.md)
|
|
- [EditGameRequestBody](docs/EditGameRequestBody.md)
|
|
- [Failure](docs/Failure.md)
|
|
- [Game](docs/Game.md)
|
|
- [GameId](docs/GameId.md)
|
|
- [Gamenight](docs/Gamenight.md)
|
|
- [GamenightId](docs/GamenightId.md)
|
|
- [Location](docs/Location.md)
|
|
- [LocationId](docs/LocationId.md)
|
|
- [Login](docs/Login.md)
|
|
- [OwnGame](docs/OwnGame.md)
|
|
- [OwnedGame](docs/OwnedGame.md)
|
|
- [Participants](docs/Participants.md)
|
|
- [Registration](docs/Registration.md)
|
|
- [Token](docs/Token.md)
|
|
- [User](docs/User.md)
|
|
- [UserId](docs/UserId.md)
|
|
|
|
|
|
To get access to the crate's generated documentation, use:
|
|
|
|
```
|
|
cargo doc --open
|
|
```
|
|
|
|
## Author
|
|
|
|
dennis@brentj.es
|
|
|