Doc fixes

Author: pacmancoder

devolutions-agent/src/updater/mod.rs

@@ -917,10 +917,7 @@ fn elapsed_since_last_check_secs(
     now_local: time::OffsetDateTime,
     last_check_at_local: Option<time::OffsetDateTime>,
 ) -> Option<u64> {
-    last_check_at_local.map(|last| {
-        u64::try_from((now_local - last).whole_seconds())
-            .unwrap_or(0)
-    })
+    last_check_at_local.map(|last| u64::try_from((now_local - last).whole_seconds()).unwrap_or(0))
 }
 
 /// Compute how long to sleep before the next auto-update check.

devolutions-gateway/openapi/gateway-api.yaml

@@ -653,7 +653,7 @@ paths:
           application/json:
             schema:
               allOf:
-              - $ref: '#/components/schemas/UpdateRequest'
+              - $ref: '#/components/schemas/UpdateRequestSchema'
               nullable: true
         required: false
       responses:
@@ -1677,17 +1677,11 @@ components:
     UpdateRequest:
       type: object
       description: |-
-        Request body for the unified update endpoint.
+        OpenAPI schema for the update request body.
 
-        Every key in `Products` is a product name. Known products (`Gateway`, `Agent`,
-        `HubService`) are processed natively; any other name is forwarded as-is to the
-        agent so future product types are supported transparently.
-      properties:
-        Products:
-          type: object
-          description: Map of product name to API-specific product info.
-          additionalProperties:
-            $ref: '#/components/schemas/UpdateProductInfo'
+        The API accepts a map from product name to update information.
+      additionalProperties:
+        $ref: '#/components/schemas/UpdateProductInfo'
     UpdateResponse:
       type: object
       description: Response returned by the update endpoint.
@@ -1721,4 +1715,3 @@ components:
       scheme: bearer
       bearerFormat: JWT
       description: Token allowing usage of the standalone web application
-

devolutions-gateway/src/api/update.rs

@@ -164,7 +164,6 @@ impl serde::Serialize for UpdateProduct {
 /// Every key in `Products` is a product name. Known products (`Gateway`, `Agent`,
 /// `HubService`) are processed natively; any other name is forwarded as-is to the
 /// agent so future product types are supported transparently.
-#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 #[derive(Debug, Default, Deserialize)]
 #[serde(rename_all = "PascalCase")]
 pub(crate) struct UpdateRequest {
@@ -173,6 +172,15 @@ pub(crate) struct UpdateRequest {
     pub products: HashMap<UpdateProduct, UpdateProductInfo>,
 }
 
+/// OpenAPI schema for the update request body.
+///
+/// The API accepts a map from product name to update information.
+#[cfg(feature = "openapi")]
+#[derive(Serialize, utoipa::ToSchema)]
+#[schema(as = UpdateRequest)]
+#[serde(transparent)]
+pub(crate) struct UpdateRequestSchema(pub HashMap<String, UpdateProductInfo>);
+
 /// Response returned by the update endpoint.
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
 #[derive(Serialize)]
@@ -270,7 +278,7 @@ fn apply_products(req: UpdateRequest, manifest: &mut UpdateManifestV2, was_v2: b
     params(
         ("version" = Option<String>, Query, deprecated, description = "Gateway-only target version; use the request body for multi-product updates"),
     ),
-    request_body(content = Option<UpdateRequest>, description = "Products and target versions to update", content_type = "application/json"),
+    request_body(content = Option<UpdateRequestSchema>, description = "Products and target versions to update", content_type = "application/json"),
     responses(
         (status = 200, description = "Update request accepted", body = UpdateResponse),
         (status = 400, description = "Bad request"),

devolutions-gateway/src/openapi.rs

@@ -55,7 +55,7 @@ use crate::config::dto::{DataEncoding, PubKeyFormat, Subscriber};
         crate::api::webapp::AppTokenSignRequest,
         crate::api::webapp::AppTokenContentType,
         crate::api::update::GetUpdateProductsResponse,
-        crate::api::update::UpdateRequest,
+        crate::api::update::UpdateRequestSchema,
         crate::api::update::UpdateProduct,
         crate::api::update::UpdateProductInfo,
         crate::api::update::UpdateResponse,