Docs.rs comments
Comments for generating the docs with cargo doc
This commit is contained in:
@@ -17,6 +17,37 @@ use crate::{
|
||||
},
|
||||
};
|
||||
|
||||
/// Creates the complete router with all API endpoints.
|
||||
///
|
||||
/// The router is organized in layers for proper middleware application:
|
||||
///
|
||||
/// ## Route Layers (from most to least restricted):
|
||||
///
|
||||
/// ### Admin-Only Routes (requires admin privilege + valid token)
|
||||
/// - `GET /api/tickets/{id}` - Get specific ticket details
|
||||
/// - `DELETE /api/tickets/{id}` - Delete a ticket
|
||||
/// - `PATCH /api/tickets/{id}` - Update ticket status
|
||||
/// - `POST /api/register` - Create a new user
|
||||
/// - `GET /api/users` - List all users
|
||||
/// - `GET /api/users/{id}` - Get user details
|
||||
/// - `DELETE /api/users/{id}` - Delete a user
|
||||
/// - `PATCH /api/users/{id}` - Update user details
|
||||
///
|
||||
/// ### Protected Routes (requires valid token)
|
||||
/// - `GET /api/tickets` - List all tickets
|
||||
/// - `POST /api/tickets/create` - Create a new ticket
|
||||
/// - `GET /api/logout` - Logout user
|
||||
/// - `GET /api/users/current` - Get current authenticated user
|
||||
///
|
||||
/// ### Public Routes (no authentication required)
|
||||
/// - `POST /api/login` - User login
|
||||
/// - `GET /api/check-admin` - Check if admin exists (for setup detection)
|
||||
/// - `POST /api/setup-admin` - Create initial admin account (only if no admin exists)
|
||||
///
|
||||
/// # Middleware Stack
|
||||
/// - Admin routes have `validate_admin` middleware
|
||||
/// - Protected routes have `validate_token` middleware
|
||||
/// - Public routes have no authentication requirements
|
||||
pub fn create_router(state: Arc<AppState>) -> Router {
|
||||
let admin_routes = Router::new()
|
||||
.route(
|
||||
|
||||
Reference in New Issue
Block a user