stop REST endpoint: expose filtering by location_type (#576)

Author: drewda

doc/openapi/rest.json

@@ -10780,6 +10780,20 @@
               }
             ]
           },
+          {
+            "description": "Filter by location_type: 0=stop/platform, 1=station, 2=entrance/exit, 3=generic node, 4=boarding area",
+            "in": "query",
+            "name": "location_type",
+            "schema": {
+              "type": "integer"
+            },
+            "x-example-requests": [
+              {
+                "description": "location_type=1",
+                "url": "location_type=1"
+              }
+            ]
+          },
           {
             "$ref": "#/components/parameters/includeAlertsParam"
           },

server/rest/stop_request.go

@@ -31,6 +31,7 @@ type StopRequest struct {
 	ServedByOnestopIds string    `json:"served_by_onestop_ids"`
 	ServedByRouteType  *int      `json:"served_by_route_type,string"`
 	ServedByRouteTypes string    `json:"served_by_route_types"`
+	LocationType       *int      `json:"location_type,string"`
 	IncludeAlerts      bool      `json:"include_alerts,string"`
 	IncludeRoutes      bool      `json:"include_routes,string"`
 	LicenseFilter
@@ -86,6 +87,13 @@ func (r StopRequest) RequestInfo() RequestInfo {
 						Schema:      newSRVal("string", "", nil),
 						Extensions:  newExt("", "served_by_route_types=1,2", "served_by_route_types=1,2"),
 					}},
+					&pref{Value: &param{
+						Name:        "location_type",
+						In:          "query",
+						Description: `Filter by location_type: 0=stop/platform, 1=station, 2=entrance/exit, 3=generic node, 4=boarding area`,
+						Schema:      newSRVal("integer", "", nil),
+						Extensions:  newExt("", "location_type=1", "location_type=1"),
+					}},
 					newPRef("includeAlertsParam"),
 					newPRef("includeRoutesParam"),
 					newPRef("idParam"),
@@ -167,6 +175,9 @@ func (r StopRequest) Query(ctx context.Context) (string, map[string]any) {
 	if r.ServedByRouteTypes != "" {
 		where["served_by_route_types"] = commaSplit(r.ServedByRouteTypes)
 	}
+	if r.LocationType != nil {
+		where["location_type"] = *r.LocationType
+	}
 	where["license"] = checkLicenseFilter(r.LicenseFilter)
 	return stopQuery, hw{
 		"limit":          r.CheckLimit(),

server/rest/stop_request_test.go

@@ -157,6 +157,18 @@ func TestStopRequest(t *testing.T) {
 			selector:     "stops.#.stop_id",
 			expectSelect: []string{"19TH", "19TH_N"},
 		},
+		{
+			name:         "location_type=0",
+			h:            StopRequest{FeedOnestopID: "BA", LocationType: ptr(0), WithCursor: WithCursor{Limit: 100}},
+			selector:     "stops.#.stop_id",
+			expectLength: 50,
+		},
+		{
+			name:         "location_type=1",
+			h:            StopRequest{FeedOnestopID: "BA", LocationType: ptr(1), WithCursor: WithCursor{Limit: 100}},
+			selector:     "stops.#.stop_id",
+			expectLength: 0,
+		},
 		{
 			name:         "search",
 			h:            StopRequest{Search: "macarthur"},