api: Fix the search API schema.

Updated the schema reference in the search API from 'Region' to 'SearchResult'. Also, added a new 'SearchResult' schema with 'id', 'name', and 'path' properties. It corresponds to the current back/front implementation. Signed-off-by: Nikolay Martyanov <[email protected]>
uncovering-world · Jan 6, 2024 · 527ad8e · 527ad8e
1 parent 41fd0b4
commit 527ad8e
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/api/api.yaml b/api/api.yaml
@@ -276,7 +276,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/Region'
+                  $ref: '#/components/schemas/SearchResult'
         '204':
           description: No regions match the query
         '400':
@@ -338,6 +338,17 @@ components:
         hasSubregions:
           type: boolean
 
+    SearchResult:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        path:
+          type: string
+          description: A ' > ' delimited string representing the hierarchical path of the region.
+
     CRS:
       type: object
       properties: