Files
gamenight/gamenight-api-client-rs

Rust API client for gamenight-api-client-rs

Api specification for a Gamenight server

For more information, please visit https://brentj.es

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec 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 DELETE /game/{gameId} Delete this game.
DefaultApi delete_game_owner DELETE /game/{gameId}/owner/{userId} no longer own this game
DefaultApi delete_gamenight_participant DELETE /gamenight/{gamenightId}/participant/{userId} deletes a gamenight participant
DefaultApi delete_location_authorized_user DELETE /location/{locationId}/authorized_user/{userId} remove an authorized user from a location
DefaultApi get_game GET /game/{gameId} Get this specific game
DefaultApi get_gamenight GET /gamenight/{gamenightId} get the specified gamenight
DefaultApi get_gamenight_participants GET /gamenight/{gamenightId}/participants Get all participants for a gamenight
DefaultApi get_gamenights GET /gamenights Get a all gamenights
DefaultApi get_games GET /games get all games
DefaultApi get_location GET /location/{locationId} gets this location
DefaultApi get_location_authorized_users GET /location/{locationId}/authorized_users/ gets this locations authorized users
DefaultApi get_locations GET /locations get all locations
DefaultApi get_user GET /user/{userId}
DefaultApi get_user_owned_games GET /user/{userId}/owned_games Get owned games of user
DefaultApi get_users GET /users Get all users
DefaultApi post_game_owners POST /game/{gameId}/owners Own this game
DefaultApi post_gamenight_participants POST /gamenight/{gamenightId}/participants Add a participant
DefaultApi post_gamenights POST /gamenights Gets the gamenight
DefaultApi post_games POST /games add a game
DefaultApi post_location_authorized_users POST /location/{locationId}/authorized_users/ Authorize a user
DefaultApi post_locations POST /locations add a location
DefaultApi post_refresh_token POST /refresh_token Refresh a user token
DefaultApi post_token POST /token Login a user.
DefaultApi post_users POST /users Registers a user into gamenight.
DefaultApi put_game PUT /game/{gameId} Changes this game resource

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

dennis@brentj.es