openapi

backend/src/routes/documents.rs

@@ -14,6 +14,7 @@ use serde::{Deserialize, Serialize};
 use serde_json::{json, Value};
 use sha2::{Digest, Sha256};
 use tracing::{debug, error, info, warn};
+use utoipa::{IntoParams, ToSchema};
 use uuid::Uuid;
 
 use super::folders::gather_descendant_folder_ids;
@@ -55,7 +56,8 @@ use search_utils::{build_quickwit_query, extract_document_id};
 const PRESIGNED_URL_EXPIRY_SECONDS: u64 = 300;
 const QUICKWIT_MAX_HITS: usize = 200;
 
-#[derive(Deserialize)]
+#[derive(Deserialize, IntoParams, ToSchema)]
+#[into_params(parameter_in = Query)]
 pub struct DocumentListQuery {
     pub folder_id: Option<Uuid>,
     #[serde(default)]
@@ -67,13 +69,14 @@ pub struct DocumentListQuery {
     pub correspondents: Option<String>,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, IntoParams, ToSchema)]
+#[into_params(parameter_in = Query)]
 pub struct AssetRequestQuery {
     #[serde(default)]
     pub force: bool,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct TagResponse {
     pub id: Uuid,
     pub label: String,
@@ -90,7 +93,7 @@ impl From<Tag> for TagResponse {
     }
 }
 
-#[derive(Serialize, Clone)]
+#[derive(Serialize, Clone, ToSchema)]
 pub struct DocumentVersionResponse {
     pub id: Uuid,
     pub version_number: i32,
@@ -103,7 +106,7 @@ pub struct DocumentVersionResponse {
     pub operations_summary: Option<Value>,
 }
 
-#[derive(Serialize, Clone)]
+#[derive(Serialize, Clone, ToSchema)]
 pub struct DocumentAssetResponse {
     pub id: Uuid,
     pub asset_type: String,
@@ -113,7 +116,7 @@ pub struct DocumentAssetResponse {
     pub cardinality: Option<i32>,
 }
 
-#[derive(Serialize, Clone)]
+#[derive(Serialize, Clone, ToSchema)]
 pub struct DocumentAssetObjectResponse {
     pub id: Uuid,
     pub ordinal: i32,
@@ -124,7 +127,7 @@ pub struct DocumentAssetObjectResponse {
     pub expires_at: Option<i64>,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct DocumentAssetDetailResponse {
     pub id: Uuid,
     pub asset_type: String,
@@ -137,7 +140,7 @@ pub struct DocumentAssetDetailResponse {
     pub objects: Vec<DocumentAssetObjectResponse>,
 }
 
-#[derive(Serialize, Clone)]
+#[derive(Serialize, Clone, ToSchema)]
 pub struct DocumentCurrentVersionResponse {
     #[serde(flatten)]
     pub version: DocumentVersionResponse,
@@ -146,7 +149,7 @@ pub struct DocumentCurrentVersionResponse {
     pub download_path: String,
 }
 
-#[derive(Serialize, Clone)]
+#[derive(Serialize, Clone, ToSchema)]
 pub struct DocumentCorrespondentResponse {
     pub id: Uuid,
     pub name: String,
@@ -155,7 +158,7 @@ pub struct DocumentCorrespondentResponse {
     pub assigned_at: String,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct DocumentResponse {
     pub id: Uuid,
     pub filename: String,
@@ -174,12 +177,12 @@ pub struct DocumentResponse {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub current_version: Option<DocumentCurrentVersionResponse>,
 }
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct DocumentDetailResponse {
     pub document: DocumentResponse,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct DocumentDownloadResponse {
     pub url: String,
     pub expires_in: u64,
@@ -188,67 +191,67 @@ pub struct DocumentDownloadResponse {
     pub size_bytes: i64,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct BulkReanalyzeResponse {
     pub queued: usize,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct BulkMoveRequest {
     pub document_ids: Vec<Uuid>,
     pub folder_id: Option<Uuid>,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct UpdateDocumentRequest {
     pub title: Option<String>,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct BulkMoveResponse {
     pub updated: usize,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 #[serde(rename_all = "snake_case")]
 pub enum BulkTagAction {
     Add,
     Remove,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct BulkTagRequest {
     pub document_ids: Vec<Uuid>,
     pub tag_ids: Vec<Uuid>,
     pub action: BulkTagAction,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct BulkTagResponse {
     pub added: usize,
     pub removed: usize,
 }
 
-#[derive(Serialize)]
+#[derive(Serialize, ToSchema)]
 pub struct BulkCorrespondentResponse {
     pub assigned: usize,
     pub removed: usize,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct CorrespondentAssignmentInput {
     pub correspondent_id: Uuid,
     pub role: String,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct AssignCorrespondentsRequest {
     pub assignments: Vec<CorrespondentAssignmentInput>,
     #[serde(default)]
     pub replace: bool,
 }
 
-#[derive(Deserialize, Copy, Clone, PartialEq, Eq)]
+#[derive(Deserialize, Copy, Clone, PartialEq, Eq, ToSchema)]
 #[serde(rename_all = "lowercase")]
 pub enum BulkCorrespondentAction {
     Add,
@@ -259,7 +262,7 @@ fn default_bulk_correspondent_action() -> BulkCorrespondentAction {
     BulkCorrespondentAction::Add
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct BulkCorrespondentsRequest {
     pub document_ids: Vec<Uuid>,
     pub assignments: Vec<CorrespondentAssignmentInput>,
@@ -267,12 +270,13 @@ pub struct BulkCorrespondentsRequest {
     pub action: BulkCorrespondentAction,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, IntoParams, ToSchema)]
+#[into_params(parameter_in = Query)]
 pub struct CorrespondentRoleQuery {
     pub role: String,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct BulkReanalyzeSelectionRequest {
     pub document_ids: Vec<Uuid>,
     #[serde(default = "default_true")]
@@ -296,17 +300,28 @@ struct UploadOutcome {
     created: bool,
 }
 
-#[derive(Deserialize)]
+#[derive(ToSchema)]
+pub struct UploadDocumentForm {
+    #[schema(value_type = String, format = Binary)]
+    pub file: String,
+    #[schema(nullable)]
+    pub folder_id: Option<Uuid>,
+    #[schema(nullable)]
+    pub metadata: Option<Value>,
+}
+
+#[derive(Deserialize, ToSchema)]
 pub struct MoveDocumentRequest {
     pub folder_id: Option<Uuid>,
 }
 
-#[derive(Deserialize)]
+#[derive(Deserialize, ToSchema)]
 pub struct AssignTagsRequest {
     pub tag_ids: Vec<Uuid>,
 }
 
-#[derive(Deserialize, Default)]
+#[derive(Deserialize, Default, IntoParams, ToSchema)]
+#[into_params(parameter_in = Query)]
 pub struct AssetObjectsQuery {
     #[serde(default)]
     pub start: Option<i32>,