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

docs: Add comprehensive descriptions to all OpenAPI documentation endpoints and schemas

Browse Source 
Co-authored-by: aider (openai/andrew/openrouter/anthropic/claude-sonnet-4) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-08-13 13:37:42 -03:00
parent 243e77fba4
commit 87e76f6314
3 changed files with 75 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -11,10 +11,12 @@ use crate::meta_plugin::MetaPluginType;
#[utoipa::path(
get,
path = "/api/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.",
responses(
(status = 200, description = "Successfully retrieved status information including database path, data directory, and supported plugins", body = ApiResponse<StatusInfo>),
(status = 200, description = "Successfully retrieved complete system status including database path, data directory, supported plugins, and system information", body = ApiResponse<StatusInfo>),
(status = 401, description = "Unauthorized - Invalid or missing authentication credentials"),
(status = 500, description = "Internal server error - Failed to retrieve status information")
(status = 500, description = "Internal server error - Failed to retrieve status information due to system error")
),
security(
("bearerAuth" = [])