4 stable releases
| new 5.2.4 | May 16, 2025 |
|---|---|
| 5.2.3 | May 12, 2025 |
#202 in Hardware support
315 downloads per month
79KB
1K
SLoC
Rust API client for foxclient
Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application's access to the API. In future, this may be a mandatory requirement.
To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit.
The requests may be logged for analytics and development purposes.
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: 5.2.3
- Package version: 5.2.3
- Generator version: 7.13.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named foxclient and add the following to Cargo.toml under [dependencies]:
foxclient = { path = "./foxclient" }
Documentation for API Endpoints
All URIs are relative to https://api.orangefox.download
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DeviceApi | get_device | GET /devices/get | Get Device |
| DeviceApi | get_device_deprecated | GET /devices/{device_id} | Get Device Short |
| DeviceApi | get_devices | GET /devices/ | Get Devices |
| DeviceApi | get_oems | GET /oems/ | Get Oems |
| ReleaseApi | get_release | GET /releases/get | Get Release |
| ReleaseApi | get_release_deprecated | GET /releases/{release_id} | Get Release Short |
| ReleaseApi | get_releases | GET /releases/ | Get Releases |
| ReleaseApi | get_updates_deprecated | GET /updates/{last_known_id} | Get Updates |
| StatsApi | get_public_stats | GET /stats/ | Public Stats |
Documentation For Models
- DeviceResponse
- GlobalStatsAggregationModel
- HttpValidationError
- ListResponseReleaseResponse
- ListResponseShortDeviceResponse
- ListResponseShortReleaseResponse
- ListResponseStr
- MaintainerShortModel
- RecoveryImgResponse
- ReleaseGroupsResponse
- ReleaseResponse
- ReleaseType
- ReleasesSort
- ResponseGetReleases
- ShortDeviceResponse
- ShortReleaseResponse
- ValidationError
- ValidationErrorLocInner
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Dependencies
~8–20MB
~278K SLoC