23019: add sortedByProximity parameter in locations.json (#255)

skedgo · Dec 5, 2024 · feb639c · feb639c
1 parent 14fe091
commit feb639c
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/specs/tripgo.openapi.yaml b/docs/specs/tripgo.openapi.yaml
@@ -2056,6 +2056,15 @@ paths:
         schema:
           type: boolean
           default: false
+      - name: sortedByProximity
+        in: query
+        description: "If enabled the the results are sorted using the distance to the `center` as measure. Nearest results should be at the beginning of the list."
+        required: false
+        style: form
+        explode: true
+        schema:
+          type: boolean
+          default: false
       responses:
         "200":
           description: Successful response

diff --git a/docs/specs/tripgo.swagger.yaml b/docs/specs/tripgo.swagger.yaml
@@ -1313,6 +1313,11 @@ paths:
           type: boolean
           description: Should "parent" public transport location (e.g., large station) include the details for each child stops (e.g., individual platforms)?
           default: false
+        - name: sortedByProximity
+          in: query
+          type: boolean
+          description: If enabled the the results are sorted using the distance to the "center" as measure. Nearest results should be at the beginning of the list.
+          default: false
       responses:
         200:
           description: Successful response