From 8dabb1c19ebecb530dfaf20366d49df9eac2fe61 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Tue, 30 Apr 2024 19:07:49 -0400 Subject: [PATCH] slightly more information on documentation, but utoipa isn't helping --- .../upload/upload_new_scene_media_file_handler.rs | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upload/upload_new_scene_media_file_handler.rs b/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upload/upload_new_scene_media_file_handler.rs index 9b1c5cff7d..37e095afea 100644 --- a/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upload/upload_new_scene_media_file_handler.rs +++ b/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upload/upload_new_scene_media_file_handler.rs @@ -34,23 +34,29 @@ use crate::server_state::ServerState; use crate::util::check_creator_tokens::{check_creator_tokens, CheckCreatorTokenArgs, CheckCreatorTokenResult}; use crate::validations::validate_idempotency_token_format::validate_idempotency_token_format; +/// Form-multipart request fields. #[derive(MultipartForm, ToSchema)] #[multipart(duplicate_field = "deny")] pub struct UploadNewSceneMediaFileForm { /// UUID for request idempotency #[multipart(limit = "2 KiB")] + #[schema(value_type = String, format = Binary)] uuid_idempotency_token: Text, + // TODO: is MultipartBytes better than TempFile ? /// The uploaded file #[multipart(limit = "512 MiB")] + #[schema(value_type = Vec, format = Binary)] file: TempFile, /// Optional: Title (name) of the scene #[multipart(limit = "2 KiB")] + #[schema(value_type = Option, format = Binary)] title: Option>, /// Optional: Visibility of the scene #[multipart(limit = "2 KiB")] + #[schema(value_type = Option, format = Binary)] visibility: Option>, } @@ -73,7 +79,10 @@ pub struct UploadNewSceneMediaFileSuccessResponse { (status = 500, description = "Server error", body = MediaFileUploadError), ), params( - ("request" = UploadNewSceneMediaFileForm, description = "Payload Form-Multipart for Request"), + ( + "request" = UploadNewSceneMediaFileForm, + description = "PLEASE SEE BOTTOM OF PAGE `UploadNewSceneMediaFileForm` FOR DETAILS ON FIELDS AND NULLABILITY." + ), ) )] pub async fn upload_new_scene_media_file_handler(