api: Add default values to parameters.

Added default values to different parameters in the api.yaml file. These include default hierarchy values for root regions, region information, subregions, parent regions, region geometry, region search, and sibling regions. Also, made the 'query' parameter required for region search. Signed-off-by: Nikolay Martyanov <[email protected]>
uncovering-world · Jan 4, 2024 · a79b8a1 · a79b8a1
1 parent 9d15c80
commit a79b8a1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/api/api.yaml b/api/api.yaml
@@ -20,6 +20,7 @@ paths:
             If not specified, the default hierarchy is used.
           schema:
             type: integer
+          default: 1
       responses:
         '200':
           description: List of root regions
@@ -50,6 +51,7 @@ paths:
             If not specified, the default hierarchy is used.
           schema:
             type: integer
+          default: 1
       responses:
         '200':
           description: Region information
@@ -79,6 +81,7 @@ paths:
           description: Whether to retrieve all nested subregions or just the immediate subregions.
           schema:
             type: boolean
+          default: false
         - name: hierarchyId
           in: query
           required: false
@@ -87,6 +90,7 @@ paths:
             If not specified, the default hierarchy is used.
           schema:
             type: integer
+          default: 1
       responses:
         '200':
           description: List of subregions
@@ -121,6 +125,7 @@ paths:
             If not specified, the default hierarchy is used.
           schema:
             type: integer
+          default: 1
       responses:
         '200':
           description: List of parent regions, including the region itself, in order
@@ -150,6 +155,7 @@ paths:
           description: Whether to resolve empty geometries by aggregating the geometries of the subregions.
           schema:
             type: boolean
+          default: false
         - name: hierarchyId
           in: query
           required: false
@@ -158,6 +164,7 @@ paths:
             If not specified, the default hierarchy is used.
           schema:
             type: integer
+          default: 1
       responses:
         '200':
           description: Geometry of the region, in GeoJSON format, always a MultiPolygon
@@ -195,6 +202,7 @@ paths:
       summary: Search for regions by name
       parameters:
         - name: query
+          required: true
           in: query
           schema:
             type: string
@@ -206,6 +214,7 @@ paths:
             If not specified, the default hierarchy is used.
           schema:
             type: integer
+          default: 1
       responses:
         '200':
           description: List of regions matching the query
@@ -237,6 +246,7 @@ paths:
             If not specified, the default hierarchy is used.
           schema:
             type: integer
+          default: 1
       responses:
         '200':
           description: List of sibling regions, including the region itself