torrust_tracker/servers/apis/v1/
mod.rs

1//! The API version `v1`.
2//!
3//! The API is organized in the following contexts:
4//!
5//! Context | Description | Version
6//! ---|---|---
7//! `Stats` | Tracker statistics | [`v1`](crate::servers::apis::v1::context::stats)
8//! `Torrents` | Torrents | [`v1`](crate::servers::apis::v1::context::torrent)
9//! `Whitelist` | Torrents whitelist | [`v1`](crate::servers::apis::v1::context::whitelist)
10//! `Authentication keys` | Authentication keys | [`v1`](crate::servers::apis::v1::context::auth_key)
11//!
12//! > **NOTICE**:
13//! - The authentication keys are only used by the HTTP tracker.
14//! - The whitelist is only used when the tracker is running in `listed` or
15//!   `private_listed` mode.
16//!
17//! Refer to the [authentication middleware](crate::servers::apis::v1::middlewares::auth)
18//! for more information about the authentication process.
19pub mod context;
20pub mod middlewares;
21pub mod responses;
22pub mod routes;