From 66ee94946a6269db9bce6f3dd4bebd0752f2d766 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Tue, 26 Mar 2024 04:34:12 -0400 Subject: [PATCH] update docs --- .../web/storyteller_web/src/api_doc.rs | 25 +++++++++++-------- .../write_scene_file_media_file_handler.rs | 6 ++--- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/crates/service/web/storyteller_web/src/api_doc.rs b/crates/service/web/storyteller_web/src/api_doc.rs index a63871cefe..c3a25da9cf 100644 --- a/crates/service/web/storyteller_web/src/api_doc.rs +++ b/crates/service/web/storyteller_web/src/api_doc.rs @@ -44,12 +44,13 @@ use crate::http_server::endpoints::media_files::list::list_media_files::*; use crate::http_server::endpoints::media_files::list::list_media_files_by_batch_token::*; use crate::http_server::endpoints::media_files::list::list_media_files_for_user::*; use crate::http_server::endpoints::media_files::rename_media_file_handler::*; +use crate::http_server::endpoints::media_files::upload::upload_engine_asset::upload_engine_asset_media_file_handler::*; use crate::http_server::endpoints::media_files::upload::upload_error::MediaFileUploadError; -use crate::http_server::endpoints::media_files::upload::upload_media_file_handler::*; -use crate::http_server::endpoints::media_files::upload_engine_asset::upload_engine_asset_media_file_handler::*; -use crate::http_server::endpoints::media_files::upload_engine_asset::upload_error::EngineAssetMediaFileUploadError; -use crate::http_server::endpoints::media_files::upload_video::upload_error::VideoMediaFileUploadError; -use crate::http_server::endpoints::media_files::upload_video::upload_video_media_file_handler::*; +use crate::http_server::endpoints::media_files::upload::upload_generic::upload_media_file_handler::*; +use crate::http_server::endpoints::media_files::upload::upload_video::upload_video_media_file_handler::*; +use crate::http_server::endpoints::media_files::upsert_write::write_engine_asset::write_engine_asset_media_file_handler::*; +use crate::http_server::endpoints::media_files::upsert_write::write_error::MediaFileWriteError; +use crate::http_server::endpoints::media_files::upsert_write::write_scene_file::write_scene_file_media_file_handler::*; use crate::http_server::endpoints::prompts::get_prompt::*; use crate::http_server::endpoints::service::status_alert_handler::*; use crate::http_server::endpoints::user_bookmarks::batch_get_user_bookmarks_handler::*; @@ -88,9 +89,11 @@ use crate::http_server::web_utils::response_success_helpers::*; crate::http_server::endpoints::media_files::list::list_media_files_by_batch_token::list_media_files_by_batch_token_handler, crate::http_server::endpoints::media_files::list::list_media_files_for_user::list_media_files_for_user_handler, crate::http_server::endpoints::media_files::rename_media_file_handler::rename_media_file_handler, - crate::http_server::endpoints::media_files::upload::upload_media_file_handler::upload_media_file_handler, - crate::http_server::endpoints::media_files::upload_engine_asset::upload_engine_asset_media_file_handler::upload_engine_asset_media_file_handler, - crate::http_server::endpoints::media_files::upload_video::upload_video_media_file_handler::upload_video_media_file_handler, + crate::http_server::endpoints::media_files::upload::upload_engine_asset::upload_engine_asset_media_file_handler::upload_engine_asset_media_file_handler, + crate::http_server::endpoints::media_files::upload::upload_generic::upload_media_file_handler::upload_media_file_handler, + crate::http_server::endpoints::media_files::upload::upload_video::upload_video_media_file_handler::upload_video_media_file_handler, + crate::http_server::endpoints::media_files::upsert_write::write_engine_asset::write_engine_asset_media_file_handler::write_engine_asset_media_file_handler, + crate::http_server::endpoints::media_files::upsert_write::write_scene_file::write_scene_file_media_file_handler::write_scene_file_media_file_handler, crate::http_server::endpoints::prompts::get_prompt::get_prompt_handler, crate::http_server::endpoints::service::status_alert_handler::status_alert_handler, crate::http_server::endpoints::user_bookmarks::batch_get_user_bookmarks_handler::batch_get_user_bookmarks_handler, @@ -144,6 +147,8 @@ use crate::http_server::web_utils::response_success_helpers::*; MediaFileModelDetails, MediaFileOriginDetails, MediaFileSocialMetaLight, + MediaFileWriteError, + MediaFileWriteError, PaginationCursors, PaginationPage, SimpleEntityStats, @@ -181,7 +186,6 @@ use crate::http_server::web_utils::response_success_helpers::*; DeleteWeightError, DeleteWeightPathInfo, DeleteWeightRequest, - EngineAssetMediaFileUploadError, EnqueueFbxToGltfRequest, EnqueueFbxToGltfRequestError, EnqueueFbxToGltfRequestSuccessResponse, @@ -289,9 +293,10 @@ use crate::http_server::web_utils::response_success_helpers::*; UserProfileUserBadge, UserRatingEntityType, UserRatingValue, - VideoMediaFileUploadError, Weight, WeightsData, + WriteEngineAssetMediaSuccessResponse, + WriteSceneFileMediaSuccessResponse, ZsDatasetRecord, )) )] diff --git a/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upsert_write/write_scene_file/write_scene_file_media_file_handler.rs b/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upsert_write/write_scene_file/write_scene_file_media_file_handler.rs index d6d8c2bcf2..1b0951e36c 100644 --- a/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upsert_write/write_scene_file/write_scene_file_media_file_handler.rs +++ b/crates/service/web/storyteller_web/src/http_server/endpoints/media_files/upsert_write/write_scene_file/write_scene_file_media_file_handler.rs @@ -32,7 +32,7 @@ use crate::validations::validate_idempotency_token_format::validate_idempotency_ // Unlike the "upload" endpoints, which are pure inserts, these endpoints are *upserts*. #[derive(Serialize, ToSchema)] -pub struct WriteEngineAssetMediaSuccessResponse { +pub struct WriteSceneFileMediaSuccessResponse { pub success: bool, pub media_file_token: MediaFileToken, } @@ -41,7 +41,7 @@ pub struct WriteEngineAssetMediaSuccessResponse { post, path = "/v1/media_files/write/scene_file", responses( - (status = 200, description = "Success Update", body = WriteEngineAssetMediaSuccessResponse), + (status = 200, description = "Success Update", body = WriteSceneFileMediaSuccessResponse), (status = 400, description = "Bad input", body = MediaFileWriteError), (status = 401, description = "Not authorized", body = MediaFileWriteError), (status = 429, description = "Too many requests", body = MediaFileWriteError), @@ -257,7 +257,7 @@ pub async fn write_scene_file_media_file_handler( info!("new media file id: {} token: {:?}", record_id, &token); - let response = WriteEngineAssetMediaSuccessResponse { + let response = WriteSceneFileMediaSuccessResponse { success: true, media_file_token: token, };