editoast: openapi: update with the new unit system

OpenRailAssociation · Dec 18, 2024 · 0a18c89 · 0a18c89
1 parent ac70f2c
commit 0a18c89
Showing 1 changed file with 49 additions and 14 deletions.
diff --git a/editoast/openapi.yaml b/editoast/openapi.yaml
@@ -2641,7 +2641,9 @@ paths:
                 total_mass:
                   type: number
                   format: double
-                  description: Total mass of the consist in kg
+                  description: |-
+                    Total mass of the consist
+                    Mass in kg
                   nullable: true
                 towed_rolling_stock_id:
                   type: integer
@@ -6958,6 +6960,7 @@ components:
         mass:
           type: number
           format: double
+          description: Mass in kg
         max_speed:
           type: number
           format: double
@@ -6983,6 +6986,7 @@ components:
         startup_time:
           type: number
           format: double
+          description: Duration in s
         supported_signaling_systems:
           $ref: '#/components/schemas/RollingStockSupportedSignalingSystems'
     LightRollingStockWithLiveries:
@@ -8628,7 +8632,9 @@ components:
         total_mass:
           type: number
           format: double
-          description: Total mass of the consist in kg
+          description: |-
+            Total mass of the consist
+            Mass in kg
           nullable: true
         towed_rolling_stock_id:
           type: integer
@@ -8711,15 +8717,17 @@ components:
         A:
           type: number
           format: double
-          description: Solid friction in N
+          description: |-
+            Solid friction in N
+            Force in N
         B:
-          type: number
-          format: double
-          description: Viscosity friction in N/(m/s)
+          $ref: '#/components/schemas/MassRate'
         C:
           type: number
           format: double
-          description: Aerodynamic drag in N/(m/s)²
+          description: |-
+            Aerodynamic drag in N/(m/s)² => kg·m⁻¹
+            Aerodynamic drag in N/(m·s⁻1)² = kg·m⁻¹
         type:
           type: string
       additionalProperties: false
@@ -8734,15 +8742,21 @@ components:
         A:
           type: number
           format: double
-          description: Solid friction in N/kg
+          description: |-
+            Solid friction in N/kg -- N = kg⋅m⋅s⁻²
+            Acceleration in m·s⁻²
         B:
           type: number
           format: double
-          description: Viscosity friction in (N/kg)/(m/s)
+          description: |-
+            Viscosity friction in (N/kg)/(m/s) — N = kg⋅m⋅s−2 => 1/s
+            Viscosity friction in N/(m·s⁻1) = s⁻¹
         C:
           type: number
           format: double
-          description: Aerodynamic drag in (N/kg)/(m/s)²
+          description: |-
+            Aerodynamic drag per kg in (N/kg)/(m/s)² => m⁻¹
+            Aerodynamic drag per kg in (N/kg)/(m/s)² = m⁻¹
         type:
           type: string
       additionalProperties: false
@@ -8768,8 +8782,6 @@ components:
       - power_restrictions
       - energy_sources
       - locked
-      - electrical_power_startup_time
-      - raise_pantograph_time
       - version
       - supported_signaling_systems
       properties:
@@ -8779,6 +8791,7 @@ components:
         comfort_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         const_gamma:
           type: number
           format: double
@@ -8787,6 +8800,7 @@ components:
         electrical_power_startup_time:
           type: number
           format: double
+          description: Duration in s
           nullable: true
         energy_sources:
           type: array
@@ -8809,9 +8823,11 @@ components:
         mass:
           type: number
           format: double
+          description: Mass in kg
         max_speed:
           type: number
           format: double
+          description: Velocity in m·s⁻¹
         metadata:
           allOf:
           - $ref: '#/components/schemas/RollingStockMetadata'
@@ -8827,15 +8843,18 @@ components:
         raise_pantograph_time:
           type: number
           format: double
+          description: Duration in s
           nullable: true
         rolling_resistance:
           $ref: '#/components/schemas/RollingResistance'
         startup_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         startup_time:
           type: number
           format: double
+          description: Duration in s
         supported_signaling_systems:
           type: array
           items:
@@ -8940,7 +8959,9 @@ components:
         electrical_power_startup_time:
           type: number
           format: double
-          description: The time the train takes before actually using electrical power (in seconds). Is null if the train is not electric.
+          description: |-
+            The time the train takes before actually using electrical power (in seconds). Is null if the train is not electric.
+            Duration in s
           example: 5.0
           nullable: true
         energy_sources:
@@ -8962,6 +8983,7 @@ components:
         mass:
           type: number
           format: double
+          description: Mass in kg
         max_speed:
           type: number
           format: double
@@ -8980,7 +9002,9 @@ components:
         raise_pantograph_time:
           type: number
           format: double
-          description: The time it takes to raise this train's pantograph in seconds. Is null if the train is not electric.
+          description: |-
+            The time it takes to raise this train's pantograph in seconds. Is null if the train is not electric.
+            Duration in s
           example: 15.0
           nullable: true
         rolling_resistance:
@@ -8992,6 +9016,7 @@ components:
         startup_time:
           type: number
           format: double
+          description: Duration in s
         supported_signaling_systems:
           $ref: '#/components/schemas/RollingStockSupportedSignalingSystems'
     RollingStockKey:
@@ -10721,6 +10746,7 @@ components:
         comfort_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         const_gamma:
           type: number
           format: double
@@ -10735,14 +10761,17 @@ components:
         length:
           type: number
           format: double
+          description: Length in m
         locked:
           type: boolean
         mass:
           type: number
           format: double
+          description: Mass in kg
         max_speed:
           type: number
           format: double
+          description: Velocity in m·s⁻¹
           nullable: true
         name:
           type: string
@@ -10753,6 +10782,7 @@ components:
         startup_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
     TowedRollingStockCountList:
       allOf:
       - $ref: '#/components/schemas/PaginationStats'
@@ -10781,6 +10811,7 @@ components:
         comfort_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
         const_gamma:
           type: number
           format: double
@@ -10792,14 +10823,17 @@ components:
         length:
           type: number
           format: double
+          description: Length in m
         locked:
           type: boolean
         mass:
           type: number
           format: double
+          description: Mass in kg
         max_speed:
           type: number
           format: double
+          description: Velocity in m·s⁻¹
           nullable: true
         name:
           type: string
@@ -10808,6 +10842,7 @@ components:
         startup_acceleration:
           type: number
           format: double
+          description: Acceleration in m·s⁻²
     TowedRollingStockLockedForm:
       type: object
       required: