From e9c6f99df2dd915589c165a6ae44313aa1c74811 Mon Sep 17 00:00:00 2001 From: Andras Schmelczer Date: Sat, 22 Mar 2025 20:30:24 +0000 Subject: [PATCH] Give unique names to path params --- .../sync_server/src/server/create_document.rs | 6 +- .../sync_server/src/server/delete_document.rs | 6 +- .../src/server/fetch_document_version.rs | 6 +- .../server/fetch_document_version_content.rs | 6 +- .../server/fetch_latest_document_version.rs | 6 +- .../src/server/fetch_latest_documents.rs | 4 +- .../sync_server/src/server/update_document.rs | 10 +-- frontend/sync-client/src/services/types.ts | 70 +++++++++---------- 8 files changed, 57 insertions(+), 57 deletions(-) diff --git a/backend/sync_server/src/server/create_document.rs b/backend/sync_server/src/server/create_document.rs index 89f54783..3b9bc794 100644 --- a/backend/sync_server/src/server/create_document.rs +++ b/backend/sync_server/src/server/create_document.rs @@ -23,7 +23,7 @@ use crate::{ // This is required for aide to infer the path parameter types and names #[derive(Deserialize, JsonSchema)] -pub struct PathParams { +pub struct CreateDocumentPathParams { vault_id: VaultId, } @@ -33,7 +33,7 @@ pub struct PathParams { #[axum::debug_handler] pub async fn create_document_multipart( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { vault_id }): Path, + Path(CreateDocumentPathParams { vault_id }): Path, State(state): State, TypedMultipart(axum_typed_multipart::TypedMultipart(request)): TypedMultipart< CreateDocumentVersionMultipart, @@ -56,7 +56,7 @@ pub async fn create_document_multipart( #[axum::debug_handler] pub async fn create_document_json( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { vault_id }): Path, + Path(CreateDocumentPathParams { vault_id }): Path, State(state): State, Json(request): Json, ) -> Result, SyncServerError> { diff --git a/backend/sync_server/src/server/delete_document.rs b/backend/sync_server/src/server/delete_document.rs index 75f90d23..4d940852 100644 --- a/backend/sync_server/src/server/delete_document.rs +++ b/backend/sync_server/src/server/delete_document.rs @@ -17,7 +17,7 @@ use crate::{ // This is required for aide to infer the path parameter types and names #[derive(Deserialize, JsonSchema)] -pub struct PathParams { +pub struct DeleteDocumentPathParams { vault_id: VaultId, document_id: DocumentId, } @@ -25,10 +25,10 @@ pub struct PathParams { #[axum::debug_handler] pub async fn delete_document( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { + Path(DeleteDocumentPathParams { vault_id, document_id, - }): Path, + }): Path, State(mut state): State, Json(request): Json, ) -> Result, SyncServerError> { diff --git a/backend/sync_server/src/server/fetch_document_version.rs b/backend/sync_server/src/server/fetch_document_version.rs index a2b157e3..be488c18 100644 --- a/backend/sync_server/src/server/fetch_document_version.rs +++ b/backend/sync_server/src/server/fetch_document_version.rs @@ -16,7 +16,7 @@ use crate::{ // This is required for aide to infer the path parameter types and names #[derive(Deserialize, JsonSchema)] -pub struct PathParams { +pub struct FetchDocumentVersionPathParams { vault_id: VaultId, document_id: DocumentId, vault_update_id: VaultUpdateId, @@ -25,11 +25,11 @@ pub struct PathParams { #[axum::debug_handler] pub async fn fetch_document_version( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { + Path(FetchDocumentVersionPathParams { vault_id, document_id, vault_update_id, - }): Path, + }): Path, State(mut state): State, ) -> Result, SyncServerError> { auth(&state, auth_header.token())?; diff --git a/backend/sync_server/src/server/fetch_document_version_content.rs b/backend/sync_server/src/server/fetch_document_version_content.rs index 203f0afb..746c9b3a 100644 --- a/backend/sync_server/src/server/fetch_document_version_content.rs +++ b/backend/sync_server/src/server/fetch_document_version_content.rs @@ -18,7 +18,7 @@ use crate::{ // This is required for aide to infer the path parameter types and names #[derive(Deserialize, JsonSchema)] -pub struct PathParams { +pub struct FetchDocumentVersionContentPathParams { vault_id: VaultId, document_id: DocumentId, vault_update_id: VaultUpdateId, @@ -27,11 +27,11 @@ pub struct PathParams { #[axum::debug_handler] pub async fn fetch_document_version_content( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { + Path(FetchDocumentVersionContentPathParams { vault_id, document_id, vault_update_id, - }): Path, + }): Path, State(mut state): State, ) -> Result { auth(&state, auth_header.token())?; diff --git a/backend/sync_server/src/server/fetch_latest_document_version.rs b/backend/sync_server/src/server/fetch_latest_document_version.rs index 331730e0..c9c2fdec 100644 --- a/backend/sync_server/src/server/fetch_latest_document_version.rs +++ b/backend/sync_server/src/server/fetch_latest_document_version.rs @@ -16,7 +16,7 @@ use crate::{ // This is required for aide to infer the path parameter types and names #[derive(Deserialize, JsonSchema)] -pub struct PathParams { +pub struct FetchLatestDocumentVersionPathParams { vault_id: VaultId, document_id: DocumentId, } @@ -24,10 +24,10 @@ pub struct PathParams { #[axum::debug_handler] pub async fn fetch_latest_document_version( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { + Path(FetchLatestDocumentVersionPathParams { vault_id, document_id, - }): Path, + }): Path, State(mut state): State, ) -> Result, SyncServerError> { auth(&state, auth_header.token())?; diff --git a/backend/sync_server/src/server/fetch_latest_documents.rs b/backend/sync_server/src/server/fetch_latest_documents.rs index b7ff09b7..89197c2e 100644 --- a/backend/sync_server/src/server/fetch_latest_documents.rs +++ b/backend/sync_server/src/server/fetch_latest_documents.rs @@ -15,7 +15,7 @@ use crate::{ // This is required for aide to infer the path parameter types and names #[derive(Deserialize, JsonSchema)] -pub struct PathParams { +pub struct FetchLatestDocumentsPathParams { vault_id: VaultId, } @@ -28,7 +28,7 @@ pub struct QueryParams { #[axum::debug_handler] pub async fn fetch_latest_documents( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { vault_id }): Path, + Path(FetchLatestDocumentsPathParams { vault_id }): Path, Query(QueryParams { since_update_id }): Query, State(mut state): State, ) -> Result, SyncServerError> { diff --git a/backend/sync_server/src/server/update_document.rs b/backend/sync_server/src/server/update_document.rs index a9b9c13e..3b83f774 100644 --- a/backend/sync_server/src/server/update_document.rs +++ b/backend/sync_server/src/server/update_document.rs @@ -25,7 +25,7 @@ use crate::{ // This is required for aide to infer the path parameter types and names #[derive(Deserialize, JsonSchema)] -pub struct PathParams { +pub struct UpdateDocumentPathParams { vault_id: VaultId, document_id: DocumentId, } @@ -33,10 +33,10 @@ pub struct PathParams { #[axum::debug_handler] pub async fn update_document_multipart( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { + Path(UpdateDocumentPathParams { vault_id, document_id, - }): Path, + }): Path, State(state): State, TypedMultipart(axum_typed_multipart::TypedMultipart(request)): TypedMultipart< UpdateDocumentVersionMultipart, @@ -57,10 +57,10 @@ pub async fn update_document_multipart( #[axum::debug_handler] pub async fn update_document_json( TypedHeader(auth_header): TypedHeader>, - Path(PathParams { + Path(UpdateDocumentPathParams { vault_id, document_id, - }): Path, + }): Path, State(state): State, Json(request): Json, ) -> Result, SyncServerError> { diff --git a/frontend/sync-client/src/services/types.ts b/frontend/sync-client/src/services/types.ts index e8a954f3..5cd674ed 100644 --- a/frontend/sync-client/src/services/types.ts +++ b/frontend/sync-client/src/services/types.ts @@ -450,6 +450,9 @@ export type webhooks = Record; export interface components { schemas: { Array_of_uint8: number[]; + CreateDocumentPathParams: { + vault_id: string; + }; CreateDocumentVersion: { contentBase64: string; /** @@ -465,6 +468,11 @@ export interface components { document_id?: string | null; relative_path: string; }; + DeleteDocumentPathParams: { + /** Format: uuid */ + document_id: string; + vault_id: string; + }; DeleteDocumentVersion: { relativePath: string; }; @@ -516,6 +524,28 @@ export interface components { /** Format: int64 */ vaultUpdateId: number; }; + FetchDocumentVersionContentPathParams: { + /** Format: uuid */ + document_id: string; + vault_id: string; + /** Format: int64 */ + vault_update_id: number; + }; + FetchDocumentVersionPathParams: { + /** Format: uuid */ + document_id: string; + vault_id: string; + /** Format: int64 */ + vault_update_id: number; + }; + FetchLatestDocumentVersionPathParams: { + /** Format: uuid */ + document_id: string; + vault_id: string; + }; + FetchLatestDocumentsPathParams: { + vault_id: string; + }; /** @description Response to a fetch latest documents request. */ FetchLatestDocumentsResponse: { /** @@ -525,41 +555,6 @@ export interface components { lastUpdateId: number; latestDocuments: components["schemas"]["DocumentVersionWithoutContent"][]; }; - PathParams: { - vault_id: string; - }; - PathParams2: { - vault_id: string; - }; - PathParams3: { - /** Format: uuid */ - document_id: string; - vault_id: string; - }; - PathParams4: { - /** Format: uuid */ - document_id: string; - vault_id: string; - }; - PathParams5: { - /** Format: uuid */ - document_id: string; - vault_id: string; - /** Format: int64 */ - vault_update_id: number; - }; - PathParams6: { - /** Format: uuid */ - document_id: string; - vault_id: string; - /** Format: int64 */ - vault_update_id: number; - }; - PathParams7: { - /** Format: uuid */ - document_id: string; - vault_id: string; - }; /** @description Response to a ping request. */ PingResponse: { /** @description Whether the client is authenticated based on the sent Authorization header. */ @@ -575,6 +570,11 @@ export interface components { causes: string[]; message: string; }; + UpdateDocumentPathParams: { + /** Format: uuid */ + document_id: string; + vault_id: string; + }; UpdateDocumentVersion: { contentBase64: string; /** Format: int64 */