simono41/db-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: repos moved to public-transport org 📝, minor fixes

Browse source
This commit is contained in:
Jannis R 2020-04-26 18:12:57 +02:00
parent 6791c1e42b
commit 6a8a832f98
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
4 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/index.md
View file

@ -71,7 +71,7 @@ Returns departures at a station.
*Note:* As stated in the [*Friendly Public Transport Format* `1.2.0`](https://github.com/public-transport/friendly-public-transport-format/tree/1.2.0), the returned `departure` and `arrival` times include the current delay. *Note:* As stated in the [*Friendly Public Transport Format* `1.2.0`](https://github.com/public-transport/friendly-public-transport-format/tree/1.2.0), the returned `departure` and `arrival` times include the current delay.
Passes all parameters into [`departures(…)` from `db-hafas`](https://github.com/derhuerst/db-hafas/blob/master/docs/departures.md). Passes all parameters into [`departures(…)` from `db-hafas`](https://github.com/public-transport/db-hafas/blob/master/docs/departures.md).
- `when`: A [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) or anything parsable by [`parse-messy-time`](https://github.com/substack/parse-messy-time#example). Default: now. - `when`: A [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) or anything parsable by [`parse-messy-time`](https://github.com/substack/parse-messy-time#example). Default: now.
- `duration`: Show departures for the next `n` minutes. Default: `10`. - `duration`: Show departures for the next `n` minutes. Default: `10`.
@ -87,7 +87,7 @@ curl 'https://2.db.transport.rest/stations/008011160/departures?when=tomorrow%20
## `GET /journeys` ## `GET /journeys`
Output from [`require('db-hafas').journeys(…)`](https://github.com/derhuerst/db-hafas#getting-started). Start location and end location must be either in [station format](#station-format) or in [POI/address format](#poiaddress-format) (you can mix them). Output from [`require('db-hafas').journeys(…)`](https://github.com/public-transport/db-hafas#getting-started). Start location and end location must be either in [station format](#station-format) or in [POI/address format](#poiaddress-format) (you can mix them).
*Note:* As stated in the [*Friendly Public Transport Format* `1.2.0`](https://github.com/public-transport/friendly-public-transport-format/tree/1.2.0), the returned `departure` and `arrival` times include the current delay. *Note:* As stated in the [*Friendly Public Transport Format* `1.2.0`](https://github.com/public-transport/friendly-public-transport-format/tree/1.2.0), the returned `departure` and `arrival` times include the current delay.
@ -191,7 +191,7 @@ curl 'https://your-api-endpoint/trips/1|229086|0|80|6102019?lineName=ICE+993'
## `GET /locations` ## `GET /locations`
Output from [`require('db-hafas').locations(…)`](https://github.com/derhuerst/db-hafas/blob/master/docs/locations.md) Output from [`require('db-hafas').locations(…)`](https://github.com/public-transport/db-hafas/blob/master/docs/locations.md)
- `query`: **Required.** (e.g. `Alexanderplatz`) - `query`: **Required.** (e.g. `Alexanderplatz`)
- `results`: How many stations shall be shown? Default: `10`. - `results`: How many stations shall be shown? Default: `10`.

2
index.js
View file

@ -19,7 +19,7 @@ const berlinHbf = '8011160'
const healthCheck = createHealthCheck(hafas, berlinHbf) const healthCheck = createHealthCheck(hafas, berlinHbf)
const config = { const config = {
hostname: process.env.HOSTNAME || '2.db.transport.rest', hostname: process.env.HOSTNAME || 'localhost',
port: process.env.PORT ? parseInt(process.env.PORT) : 3000, port: process.env.PORT ? parseInt(process.env.PORT) : 3000,
name: pkg.name, name: pkg.name,
description: pkg.description, description: pkg.description,

2
package.json
View file

@ -10,7 +10,7 @@
"lib" "lib"
], ],
"author": "Jannis R <mail@jannisr.de>", "author": "Jannis R <mail@jannisr.de>",
"homepage": "https://github.com/derhuerst/db-rest", "homepage": "https://github.com/derhuerst/db-rest/tree/2",
"repository": "derhuerst/db-rest", "repository": "derhuerst/db-rest",
"bugs": "https://github.com/derhuerst/db-rest/issues", "bugs": "https://github.com/derhuerst/db-rest/issues",
"license": "ISC", "license": "ISC",

2
readme.md
View file

@ -1,6 +1,6 @@
# db-rest # db-rest
**A clean REST API wrapping around the [Deutsche Bahn](https://en.wikipedia.org/wiki/Deutsche_Bahn) [API](https://github.com/derhuerst/db-hafas#db-hafas).** **A clean REST API wrapping around the [Deutsche Bahn](https://en.wikipedia.org/wiki/Deutsche_Bahn) [API](https://github.com/public-transport/db-hafas#db-hafas).**
[API Documentation](docs/index.md) | [Why?](docs/why.md) [API Documentation](docs/index.md) | [Why?](docs/why.md)