Skip to content

Commit aa1652e

Browse files
avatarneilthekaveman
avatarneil
authored and
thekaveman
committed
Add managed_by property, clean up some general-information references
1 parent 562d6b9 commit aa1652e

3 files changed

Lines changed: 30 additions & 29 deletions

File tree

‎agency/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -241,24 +241,24 @@ The `/stops` endpoint allows an agency to register Stops.
241241
**Endpoint:** `/stops`
242242
**Method:** `POST`
243243
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
244-
**Request Body**: An array of [Stops](../general-information.md/#stop)
244+
**Request Body**: An array of [Stops](/general-information.md#stop)
245245

246246
**Endpoint:** `/stops`
247247
**Method:** `PUT`
248248
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
249-
**Request Body**: An array of subsets of [Stop](../general-information.md/#stop) information, where the permitted subset fields are defined as:
249+
**Request Body**: An array of subsets of [Stop](/general-information.md#stop) information, where the permitted subset fields are defined as:
250250
| Field | Required/Optional | Description |
251251
|---------------------|-------------------|---------------------------------------------|
252-
| stop_id | Required |See [Stops](../general-information.md/#stop) |
253-
| status | Optional |See [Stops](../general-information.md/#stop) |
254-
| num_spots_disabled | Optional |See [Stops](../general-information.md/#stop) |
252+
| stop_id | Required |See [Stops](/general-information.md#stop) |
253+
| status | Optional |See [Stops](/general-information.md#stop) |
254+
| num_spots_disabled | Optional |See [Stops](/general-information.md#stop) |
255255

256256
TBD -- Are there additional fields that should be permitted to update with a PUT?
257257

258258
**Endpoint:** `/stops/:stop_id`
259259
**Method:** `GET`
260260
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
261-
**`data` Payload:** `{ "stops": [] }`, an array of [Stops](../general-information.md/#stop)
261+
**`data` Payload:** `{ "stops": [] }`, an array of [Stops](/general-information.md#stop)
262262

263263
In the case that a `stop_id` query parameter is specified, the `stops` array returned will only have one entry. In the case that no `stop_id` query parameter is specified, all stops will be returned.
264264

‎general-information.md‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -108,27 +108,28 @@ All String fields, such as `vehicle_id`, are limited to a maximum of 255 charact
108108

109109
## Stops
110110

111-
| Field | Type | Required/Optional | Description |
112-
|------------------------|-----------------------------------------------------------------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
113-
| stop_id | UUID | Required | Unique ID for stop |
114-
| stop_name | String | Required | Name of stop |
115-
| last_reported | Timestamp | Required | Date/Time that the stop was last updated |
116-
| location | GeoJSON [Point Feature](provider/README.md#geographic-data) | Required | Location of the Stop |
117-
| status | Enum | Required | Status of the Stop. See [Stop Statuses](#stop-statuses) table. |
118-
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
119-
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
120-
| num_vehicles_disabled | {vehicle_type: number} | Required | How many vehicles are unavailable/reserved per vehicle_type at this stop? |
121-
| geography_id | UUID | Optional | Pointer to the Geography that represents the Stop geospatially |
122-
| region_id | string | Optional | ID of the region where station is located, see [GBFS Station Information](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
123-
| short_name | String | Optional | Abbreviated stop name |
124-
| address | String | Optional | Postal address (useful for directions) |
125-
| post_code | String | Optional | Postal code (e.g. `10036`) |
126-
| rental_methods | [Enum](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) | Optional | Payment methods accepted at stop, see [GBFS Rental Methods](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
127-
| cross_street | String | Optional | Cross street of where the station is located. |
128-
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
129-
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
130-
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
131-
| vehicle_ids | UUID[] | Optional | List of device_ids for vehicles which are currently at this stop | |
111+
| Field | Type | Required/Optional | Description |
112+
|------------------------|-----------------------------------------------------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
113+
| stop_id | UUID | Required | Unique ID for stop |
114+
| stop_name | String | Required | Name of stop |
115+
| last_reported | Timestamp | Required | Date/Time that the stop was last updated |
116+
| location | GeoJSON [Point Feature](provider/README.md#geographic-data) | Required | Location of the Stop |
117+
| status | Enum | Required | Status of the Stop. See [Stop Statuses](#stop-statuses) table. |
118+
| capacity | {vehicle_type: number} | Required | Number of total spots per vehicle_type |
119+
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
120+
| num_vehicles_disabled | {vehicle_type: number} | Required | How many vehicles are unavailable/reserved per vehicle_type at this stop? |
121+
| managed_by | UUID | Optional | `provider_id` for the provider which manages this stop. null/undefined if city managed. |
122+
| geography_id | UUID | Optional | Pointer to the Geography that represents the Stop geospatially |
123+
| region_id | string | Optional | ID of the region where station is located, see [GBFS Station Information](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
124+
| short_name | String | Optional | Abbreviated stop name |
125+
| address | String | Optional | Postal address (useful for directions) |
126+
| post_code | String | Optional | Postal code (e.g. `10036`) |
127+
| rental_methods | [Enum](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) | Optional | Payment methods accepted at stop, see [GBFS Rental Methods](https://github.com/NABSA/gbfs/blob/master/gbfs.md#station_informationjson) |
128+
| cross_street | String | Optional | Cross street of where the station is located. |
129+
| num_spots_available | {vehicle_type: number} | Optional | How many spots are free to be populated with vehicles at this stop? |
130+
| num_spots_disabled | {vehicle_type: number} | Optional | How many docks are disabled and unable to accept vehicles at this stop? |
131+
| parent_stop | UUID | Optional | Describe a basic hierarchy of stops (e.g.a stop inside of a greater stop) |
132+
| vehicle_ids | UUID[] | Optional | List of device_ids for vehicles which are currently at this stop |
132133

133134
### Stop Statuses
134135

@@ -142,7 +143,7 @@ All String fields, such as `vehicle_id`, are limited to a maximum of 255 charact
142143

143144
Some of the fields in the `Stops` definition are using notions which are currently not in MDS, such as `rental_methods`. These fields are included for compatibility with GBFS.
144145

145-
[Top](#table-of-contents)
146+
[Top][toc]
146147

147148
## Timestamps
148149

‎provider/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ In addition to the standard [Provider payload wrapper](#response-format), respon
356356
**Endpoint:** `/stops/:stop_id`
357357
**Method:** `GET`
358358
**[Beta feature](/general-information.md#beta-features):** Yes (as of 1.0.0)
359-
**`data` Payload:** `{ "stops": [] }`, an array of [Stops](../general-information.md/#stop)
359+
**`data` Payload:** `{ "stops": [] }`, an array of [Stops](/general-information.md#stop)
360360

361361
In the case that a `stop_id` query parameter is specified, the `stops` array returned will only have one entry. In the case that no `stop_id` query parameter is specified, all stops will be returned.
362362

0 commit comments

Comments
 (0)