Skip to content

Commit 803f0e9

Browse files
committed
minor markdown cleanups
* remove extra spaces at end of line * proper list formatting * remove inline HTML * correct heading level
1 parent 5fb3ec5 commit 803f0e9

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

provider/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ This specification contains a data standard for *mobility as a service* provider
88
* [Trips](#trips)
99
* [Status Changes](#status-changes)
1010
* [Realtime Data](#realtime-data)
11-
- [GBFS](#GBFS)
12-
- [Events](#events)
11+
* [GBFS](#GBFS)
12+
* [Events](#events)
1313

1414
## General Information
1515

@@ -125,7 +125,7 @@ The following keys must be used for pagination links:
125125
* `prev`: url to the previous page of data
126126
* `next`: url to the next page of data
127127

128-
At a minimum, paginated payloads must include a `next` key, which must be set to `null` to indicate the last page of data.
128+
At a minimum, paginated payloads must include a `next` key, which must be set to `null` to indicate the last page of data.
129129

130130
```json
131131
{
@@ -178,7 +178,8 @@ represented as a GeoJSON [`Feature`](https://tools.ietf.org/html/rfc7946#section
178178

179179
For the purposes of this specification, the intersection of two geographic datatypes is defined according to the [`ST_Intersects` PostGIS operation](https://postgis.net/docs/ST_Intersects.html)
180180

181-
> If a geometry or geography shares any portion of space then they intersect. For geography -- tolerance is 0.00001 meters (so any points that are close are considered to intersect).<br>
181+
> If a geometry or geography shares any portion of space then they intersect. For geography -- tolerance is 0.00001 meters (so any points that are close are considered to intersect).
182+
>
182183
> Overlaps, Touches, Within all imply spatial intersection. If any of the aforementioned returns true, then the geometries also spatially intersect. Disjoint implies false for spatial intersection.
183184
184185
[Top][toc]
@@ -242,7 +243,6 @@ Method: `GET`
242243
Schema: [`trips` schema][trips-schema]
243244
`data` Payload: `{ "trips": [] }`, an array of objects with the following structure
244245

245-
246246
| Field | Type | Required/Optional | Comments |
247247
| ----- | -------- | ----------------- | ----- |
248248
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS |
@@ -276,7 +276,7 @@ If the data does not exist or the hour has not completed, `/trips` shall return
276276

277277
Without an `end_time` query parameter, `/trips` shall return a `400 Bad Request` error.
278278

279-
For the near-ish real time use cases, please use the [events](#events) endpoint.
279+
For the near-ish real time use cases, please use the [events](#events) endpoint.
280280

281281
### Routes
282282

@@ -348,7 +348,7 @@ Schema: [`status_changes` schema][sc-schema]
348348
| `event_location` | GeoJSON [Point Feature][geo] | Required | |
349349
| `battery_pct` | Float | Required if Applicable | Percent battery charge of device, expressed between 0 and 1 |
350350
| `associated_trip` | UUID | Required if Applicable | Trip UUID (foreign key to Trips API), required if `event_type_reason` is `user_pick_up` or `user_drop_off`, or for any other status change event that marks the end of a trip. |
351-
| `associated_ticket` | String | Optional | Identifier for an associated ticket inside an Agency-maintained 311 or CRM system. |
351+
| `associated_ticket` | String | Optional | Identifier for an associated ticket inside an Agency-maintained 311 or CRM system. |
352352

353353
### Event Times
354354

@@ -389,12 +389,12 @@ Without an `event_time` query parameter, `/status_changes` shall return a `400 B
389389

390390
### GBFS
391391

392-
All MDS compatible `provider` APIs must expose a public [GBFS](https://github.com/NABSA/gbfs) feed as well. Given that GBFS hasn't fully [evolved to support dockless mobility](https://github.com/NABSA/gbfs/pull/92) yet, we follow the current guidelines in making bike information avaliable to the public.
392+
All MDS compatible `provider` APIs must expose a public [GBFS](https://github.com/NABSA/gbfs) feed as well. Given that GBFS hasn't fully [evolved to support dockless mobility](https://github.com/NABSA/gbfs/pull/92) yet, we follow the current guidelines in making bike information avaliable to the public.
393393

394-
- `gbfs.json` is always required and must contain a `feeds` property that lists all published feeds
395-
- `system_information.json` is always required
396-
- `free_bike_status.json` is required for MDS
397-
- `station_information.json` and `station_status.json` don't apply for MDS
394+
* `gbfs.json` is always required and must contain a `feeds` property that lists all published feeds
395+
* `system_information.json` is always required
396+
* `free_bike_status.json` is required for MDS
397+
* `station_information.json` and `station_status.json` don't apply for MDS
398398

399399
### Events
400400

@@ -413,11 +413,11 @@ Method: `GET`
413413
Schema: [`status_changes` schema][sc-schema]
414414
`data` Payload: `{ "status_changes": [] }`, an array of objects with the same structure as in [`/status_changes`][status]
415415

416-
### Event Times
416+
#### Event Times
417417

418418
Because of the unreliability of device clocks, the Provider is unlikely to know with total confidence what time an event occurred at. However, they are responsible for constructing as accurate a timeline as possible. Most importantly, the order of the timestamps for a particular device's events must reflect the Provider's best understanding of the order in which those events occurred.
419419

420-
### Events Query Parameters
420+
#### Events Query Parameters
421421

422422
The events API should allow querying with a combination of query parameters:
423423

0 commit comments

Comments
 (0)