editoast: use macro annotate_unites

Signed-off-by: Tristram Gräbener <[email protected]>
OpenRailAssociation · Dec 9, 2024 · 84d100e · 84d100e
1 parent d5e9940
commit 84d100e
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 4 deletions.
diff --git a/editoast/openapi.yaml b/editoast/openapi.yaml
@@ -2573,7 +2573,9 @@ paths:
                 max_speed:
                   type: number
                   format: double
-                  description: Maximum speed of the consist in km/h
+                  description: |-
+                    Maximum speed of the consist in km/h
+                    Velocity in km·h⁻¹
                   nullable: true
                 maximum_departure_delay:
                   type: integer
@@ -2632,7 +2634,9 @@ paths:
                 total_length:
                   type: number
                   format: double
-                  description: Total length of the consist in meters
+                  description: |-
+                    Total length of the consist in meters
+                    Length in m
                   nullable: true
                 total_mass:
                   type: number
@@ -6927,6 +6931,7 @@ components:
         comfort_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         const_gamma:
           type: number
           format: double
@@ -6945,6 +6950,7 @@ components:
         length:
           type: number
           format: double
+          description: Length in m
         loading_gauge:
           $ref: '#/components/schemas/LoadingGaugeType'
         locked:
@@ -6955,6 +6961,7 @@ components:
         max_speed:
           type: number
           format: double
+          description: Velocity in m·s⁻¹
         metadata:
           allOf:
           - $ref: '#/components/schemas/RollingStockMetadata'
@@ -6972,6 +6979,7 @@ components:
         startup_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         startup_time:
           type: number
           format: double
@@ -8552,7 +8560,9 @@ components:
         max_speed:
           type: number
           format: double
-          description: Maximum speed of the consist in km/h
+          description: |-
+            Maximum speed of the consist in km/h
+            Velocity in km·h⁻¹
           nullable: true
         maximum_departure_delay:
           type: integer
@@ -8611,7 +8621,9 @@ components:
         total_length:
           type: number
           format: double
-          description: Total length of the consist in meters
+          description: |-
+            Total length of the consist in meters
+            Length in m
           nullable: true
         total_mass:
           type: number
@@ -8789,6 +8801,7 @@ components:
         length:
           type: number
           format: double
+          description: Length in m
         loading_gauge:
           $ref: '#/components/schemas/LoadingGaugeType'
         locked:
@@ -8918,6 +8931,7 @@ components:
         comfort_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         const_gamma:
           type: number
           format: double
@@ -8939,6 +8953,7 @@ components:
         length:
           type: number
           format: double
+          description: Length in m
         loading_gauge:
           $ref: '#/components/schemas/LoadingGaugeType'
         locked:
@@ -8950,6 +8965,7 @@ components:
         max_speed:
           type: number
           format: double
+          description: Velocity in m·s⁻¹
         metadata:
           allOf:
           - $ref: '#/components/schemas/RollingStockMetadata'
@@ -8972,6 +8988,7 @@ components:
         startup_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         startup_time:
           type: number
           format: double

diff --git a/editoast/src/models/rolling_stock_model.rs b/editoast/src/models/rolling_stock_model.rs
@@ -30,6 +30,7 @@ editoast_common::schemas! {
     PowerRestriction,
 }
 
+#[editoast_derive::annotate_units]
 #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Model, ToSchema)]
 #[model(table = editoast_models::tables::rolling_stock)]
 #[model(gen(ops = crud, batch_ops = r, list))]

diff --git a/editoast/src/models/towed_rolling_stock.rs b/editoast/src/models/towed_rolling_stock.rs
@@ -9,6 +9,7 @@ use validator::Validate;
 
 use crate::models::prelude::*;
 
+#[editoast_derive::annotate_units]
 #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Model, ToSchema)]
 #[model(table = editoast_models::tables::towed_rolling_stock)]
 #[model(gen(ops = crud, batch_ops = r, list))]

diff --git a/editoast/src/views/rolling_stock/form.rs b/editoast/src/views/rolling_stock/form.rs
@@ -19,6 +19,7 @@ use crate::models::Changeset;
 use crate::models::Model;
 use crate::models::RollingStockModel;
 
+#[editoast_derive::annotate_units]
 #[derive(Debug, Clone, Deserialize, Serialize, ToSchema, Validate)]
 #[validate(schema(function = "validate_rolling_stock_form"))]
 pub struct RollingStockForm {

diff --git a/editoast/src/views/rolling_stock/light.rs b/editoast/src/views/rolling_stock/light.rs
@@ -206,6 +206,7 @@ async fn get_by_name(
     Ok(Json(light_rolling_stock_with_liveries))
 }
 
+#[editoast_derive::annotate_units]
 #[derive(Debug, Serialize, ToSchema)]
 #[cfg_attr(test, derive(Deserialize))]
 struct LightRollingStock {

diff --git a/editoast/src/views/timetable/stdcm/request.rs b/editoast/src/views/timetable/stdcm/request.rs
@@ -67,6 +67,7 @@ struct StepTimingData {
 }
 
 /// An STDCM request
+#[editoast_derive::annotate_units]
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Validate, ToSchema)]
 pub(super) struct Request {
     /// Deprecated, first step arrival time should be used instead