editoast: add utoipa annotation to infra list endpoint

Author: leovalais

editoast/openapi.yaml

@@ -9287,42 +9287,40 @@ paths:
   /infra/:
     get:
       parameters:
-      - description: Page number
-        in: query
+      - in: query
         name: page
+        required: false
         schema:
           default: 1
+          format: int64
           minimum: 1
           type: integer
-      - description: Number of elements by page
-        in: query
+      - in: query
         name: page_size
+        required: false
         schema:
           default: 25
-          maximum: 10000
+          format: int64
           minimum: 1
+          nullable: true
           type: integer
       responses:
         '200':
           content:
             application/json:
               schema:
-                properties:
-                  count:
-                    type: number
-                  next: {}
-                  previous: {}
-                  results:
-                    items:
-                      $ref: '#/components/schemas/Infra'
-                    type: array
-                required:
-                - count
-                - next
-                - previous
-                type: object
-          description: The infras list
-      summary: Paginated list of all available infras
+                allOf:
+                - $ref: '#/components/schemas/PaginationStats'
+                - properties:
+                    results:
+                      items:
+                        $ref: '#/components/schemas/InfraWithState'
+                      type: array
+                  required:
+                  - results
+                  type: object
+          description: All infras, paginated
+      summary: Lists all infras along with their current loading state in Core
       tags:
       - infra
     post:

editoast/openapi_legacy.yaml

@@ -22,43 +22,6 @@ tags:
 
 paths:
   /infra/:
-    get:
-      tags:
-        - infra
-      summary: Paginated list of all available infras
-      parameters:
-        - description: Page number
-          in: query
-          name: page
-          schema:
-            default: 1
-            minimum: 1
-            type: integer
-        - description: Number of elements by page
-          in: query
-          name: page_size
-          schema:
-            default: 25
-            maximum: 10000
-            minimum: 1
-            type: integer
-      responses:
-        200:
-          description: The infras list
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  count:
-                    type: number
-                  next: {}
-                  previous: {}
-                  results:
-                    type: array
-                    items:
-                      $ref: "#/components/schemas/Infra"
-                required: [count, next, previous]
     post:
       tags:
         - infra

editoast/src/views/infra/mod.rs

@@ -76,6 +76,7 @@ crate::routes! {
             get_voltages,
             get_switch_types,
         },
+        list,
         get_all_voltages,
         railjson::routes(),
     },
@@ -218,7 +219,14 @@ struct InfraListResponse {
     results: Vec<InfraWithState>,
 }
 
-/// Return a list of infras
+/// Lists all infras along with their current loading state in Core
+#[utoipa::path(
+    tag = "infra",
+    params(PaginationQueryParam),
+    responses(
+        (status = 200, description = "All infras, paginated", body = inline(InfraListResponse))
+    ),
+)]
 #[get("")]
 async fn list(
     db_pool: Data<DbConnectionPool>,

front/src/common/api/osrdEditoastApi.ts

@@ -1049,17 +1049,12 @@ export type GetElectricalProfileSetByElectricalProfileSetIdLevelOrderApiArg = {
 };
 export type GetHealthApiResponse = unknown;
 export type GetHealthApiArg = void;
-export type GetInfraApiResponse = /** status 200 The infras list */ {
-  count: number;
-  next: any;
-  previous: any;
-  results?: Infra[];
+export type GetInfraApiResponse = /** status 200 All infras, paginated */ PaginationStats & {
+  results: InfraWithState[];
 };
 export type GetInfraApiArg = {
-  /** Page number */
   page?: number;
-  /** Number of elements by page */
-  pageSize?: number;
+  pageSize?: number | null;
 };
 export type PostInfraApiResponse = /** status 201 The created infra */ Infra;
 export type PostInfraApiArg = {
@@ -1894,6 +1889,20 @@ export type ElectricalProfileSet = {
   id: number;
   name: string;
 };
+export type PaginationStats = {
+  /** The total number of items */
+  count: number;
+  /** The current page number */
+  current: number;
+  /** The next page number, if any */
+  next: number | null;
+  /** The total number of pages */
+  page_count: number;
+  /** The number of items per page */
+  page_size: number;
+  /** The previous page number, if any */
+  previous: number | null;
+};
 export type Infra = {
   created: string;
   generated_version: string | null;
@@ -1904,6 +1913,20 @@ export type Infra = {
   railjson_version: string;
   version: string;
 };
+export type InfraState =
+  | 'NOT_LOADED'
+  | 'INITIALIZING'
+  | 'DOWNLOADING'
+  | 'PARSING_JSON'
+  | 'PARSING_INFRA'
+  | 'LOADING_SIGNALS'
+  | 'BUILDING_BLOCKS'
+  | 'CACHED'
+  | 'TRANSIENT_ERROR'
+  | 'ERROR';
+export type InfraWithState = Infra & {
+  state: InfraState;
+};
 export type BufferStop = {
   extensions?: {
     sncf?: {
@@ -2267,20 +2290,6 @@ export type InfraError = {
     obj_type: 'TrackSection' | 'Signal' | 'BufferStop' | 'Detector' | 'Switch' | 'Route';
   };
 };
-export type InfraState =
-  | 'NOT_LOADED'
-  | 'INITIALIZING'
-  | 'DOWNLOADING'
-  | 'PARSING_JSON'
-  | 'PARSING_INFRA'
-  | 'LOADING_SIGNALS'
-  | 'BUILDING_BLOCKS'
-  | 'CACHED'
-  | 'TRANSIENT_ERROR'
-  | 'ERROR';
-export type InfraWithState = Infra & {
-  state: InfraState;
-};
 export type BoundingBox = (number & number)[][];
 export type PathfindingOutput = {
   detectors: string[];
@@ -2469,20 +2478,6 @@ export type ElectrificationsOnPathResponse = {
   electrification_ranges: RangedValue[];
   warnings: InternalError[];
 };
-export type PaginationStats = {
-  /** The total number of items */
-  count: number;
-  /** The current page number */
-  current: number;
-  /** The next page number, if any */
-  next: number | null;
-  /** The total number of pages */
-  page_count: number;
-  /** The number of items per page */
-  page_size: number;
-  /** The previous page number, if any */
-  previous: number | null;
-};
 export type Tags = string[];
 export type Project = {
   budget?: number | null;