Skip to content

Commit

Permalink
ci, docs
Browse files Browse the repository at this point in the history
  • Loading branch information
traines-source committed Dec 18, 2024
1 parent 59bd56e commit d24a341
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ jobs:
id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
- name: Build and push Docker image
id: push
uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
with:
context: .
push: true
tags: latest
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

build-pkg:
Expand Down
4 changes: 3 additions & 1 deletion docs/db-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,12 @@ EPs:
* angebote/fahrplan (for route planning)
* reiseloesung/orte
* reiseloesung/orte/nearby
* reiseloesung/verbindung
* reiseloesung/fahrt

Notes:
* no API Key needed
* uses HAFAS trip IDs
* provides loadFactor
* no boards (?)

* polylines only for /verbindung and /fahrt
4 changes: 3 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,16 @@ This is a very early version. What works:
* `journeys()`, `refreshJourney()` including prices
* `locations()`, `nearby()`
* `departures()`, `arrivals()` boards
* `trip()`

What doesn't work (yet, see TODO's scattered around the code):

* `journeys()` details like scheduledDays, stop/station groups, some line details ...
* `journeys()` uses different tripIds compared to departure and arrival boards...
* certain stop details like products for `locations()` and geopositions and remarks for boards
* some query options/filters (e.g. direction for boards)
* all other endpoints
* polylines only in `trips()`
* all other endpoints (`tripsByName()`, `radar()`, `journeysFromTrip()`, `reachableFrom()`, `remarks()`, `lines()`, `stop()`, `station()`)

Feel free to report anything that you stumble upon via Issues or create a PR :)

Expand Down

0 comments on commit d24a341

Please sign in to comment.