kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-23 07:09:35 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

ci, docs

Browse source
This commit is contained in:
Traines 2024-12-18 02:02:05 +00:00
parent 59bd56e824
commit d24a341def
3 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/workflows/build.yml vendored
View file

@ -33,14 +33,14 @@ jobs:
id: meta id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
with: with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
- name: Build and push Docker image - name: Build and push Docker image
id: push id: push
uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
with: with:
context: . context: .
push: true push: true
tags: latest tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }} labels: ${{ steps.meta.outputs.labels }}
build-pkg: build-pkg:

4
docs/db-apis.md
View file

@ -74,10 +74,12 @@ EPs:
* angebote/fahrplan (for route planning) * angebote/fahrplan (for route planning)
* reiseloesung/orte * reiseloesung/orte
* reiseloesung/orte/nearby * reiseloesung/orte/nearby
* reiseloesung/verbindung
* reiseloesung/fahrt
Notes: Notes:
* no API Key needed * no API Key needed
* uses HAFAS trip IDs * uses HAFAS trip IDs
* provides loadFactor * provides loadFactor
* no boards (?) * no boards (?)
* polylines only for /verbindung and /fahrt

4
readme.md
View file

@ -10,6 +10,7 @@ This is a very early version. What works:
* `journeys()`, `refreshJourney()` including prices * `journeys()`, `refreshJourney()` including prices
* `locations()`, `nearby()` * `locations()`, `nearby()`
* `departures()`, `arrivals()` boards * `departures()`, `arrivals()` boards
* `trip()`
What doesn't work (yet, see TODO's scattered around the code): What doesn't work (yet, see TODO's scattered around the code):
@ -17,7 +18,8 @@ What doesn't work (yet, see TODO's scattered around the code):
* `journeys()` uses different tripIds compared to departure and arrival boards... * `journeys()` uses different tripIds compared to departure and arrival boards...
* certain stop details like products for `locations()` and geopositions and remarks for boards * certain stop details like products for `locations()` and geopositions and remarks for boards
* some query options/filters (e.g. direction 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 :) Feel free to report anything that you stumble upon via Issues or create a PR :)