Rust API client for puddle-farm-api-client_openapi_client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
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: v1
- Package version: 1.0.0
- Generator version: 7.14.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named puddle-farm-api-client_openapi_client and add the following to Cargo.toml under [dependencies]:
puddle-farm-api-client_openapi_client = { path = "./puddle-farm-api-client_openapi_client" }
Documentation for API Endpoints
All URIs are relative to https://puddle.farm/api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | alias_player_id_get | GET /alias/{player_id} | Get player's aliases |
| DefaultApi | characters_get | GET /characters | Get a list of all characters |
| DefaultApi | claim_player_id_get | GET /claim/{player_id} | Initiate a claim for a player's profile |
| DefaultApi | claim_poll_player_id_get | GET /claim/poll/{player_id} | Poll for the status of a player's profile claim |
| DefaultApi | matchups_get | GET /matchups | Get character matchup data |
| DefaultApi | matchups_player_id_char_id_get | GET /matchups/{player_id}/{char_id} | Get player's character matchup data |
| DefaultApi | player_id_get | GET /player/{id} | Get player by ID |
| DefaultApi | player_player_id_char_id_history_get | GET /player/{player_id}/{char_id}/history | Get player's match history for a specific character |
| DefaultApi | player_search_get | GET /player/search | Search for players by name |
| DefaultApi | popularity_get | GET /popularity | Get character popularity data |
| DefaultApi | ratings_player_id_char_id_get | GET /ratings/{player_id}/{char_id} | Get player's rating history for a specific character |
| DefaultApi | settings_key_get | GET /settings/{key} | Get player's settings |
| DefaultApi | stats_get | GET /stats | Get global statistics |
| DefaultApi | supporters_get | GET /supporters | Get list of supporters |
| DefaultApi | toggle_private_key_get | GET /toggle_private/{key} | Toggle player's privacy setting |
| DefaultApi | top_char_char_id_get | GET /top_char/{char_id} | Get top ranked players for a specific character |
| DefaultApi | top_get | GET /top | Get top ranked players |
Documentation For Models
- MatchupCharResponse
- MatchupEntry
- MatchupResponse
- PlayerGamesResponse
- PlayerRankResponse
- PlayerResponse
- PlayerResponsePlayer
- PlayerSearchResponse
- PlayerSet
- PopularityResult
- PopularityResultChar
- RankResponse
- RatingsResponse
- SearchResponse
- SettingsResponse
- StatsResponse
- Supporter
- TagResponse
To get access to the crate's generated documentation, use:
cargo doc --open