asp/keep
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: simplify API endpoint descriptions

Browse Source 
Co-authored-by: aider (openai/andrew/openrouter/deepseek/deepseek-chat-v3.1) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-08-28 16:45:43 -03:00
parent fee576f638
commit 10c7ab9679
3 changed files with 56 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/modes/server/api/status.rs
View File

@@ -15,11 +15,11 @@ use crate::compression_engine::CompressionType;
path = "/api/status",
operation_id = "status",
summary = "Get system status",
description = "Retrieve comprehensive system status information including database configuration, data storage paths, supported compression engines, available metadata plugins, and system capabilities. This endpoint is useful for health checks and system diagnostics.",
description = "Retrieve system status including database info, storage paths, compression engines, and metadata plugins.",
responses(
(status = 200, description = "Successfully retrieved complete system status including database path, data directory, supported plugins, and system information", body = StatusInfoResponse),
(status = 401, description = "Unauthorized - Invalid or missing authentication credentials"),
(status = 500, description = "Internal server error - Failed to retrieve status information due to system error")
(status = 200, description = "System status retrieved", body = StatusInfoResponse),
(status = 401, description = "Unauthorized"),
(status = 500, description = "Internal server error")
),
security(
("bearerAuth" = [])