Merge pull request #27 from geertw/develop

Release 1.5.0

CHANGELOG.md

@@ -1,8 +1,20 @@
 # Changelog
 
+## 1.5.0
+
+* Let op: HTTP interface is gewijzigd. Bestaande URL's hebben nu /v1 als
+  prefix, gebruik /v2 voor nieuwe toepassingen
+* Opvragen ritinformatie toegevoegd
+* Voor ritinfo en vertrekdetails is nu een fallback op rdt-serviceinfo
+* Ritten worden tot 120 minuten na vertrek in geheugen bewaard
+* Ondersteuning voor DVS injecties met vertraging
+* Documentatie HTTP interface verbeterd (zie /doc)
+* Vertalingen bijgewerkt
+
 ## 1.4.3
 
-* Detectie op DVS-berichten die minder dan 70 minuten voor vertrek worden ontvangen
+* Detectie op DVS-berichten die minder dan 70 minuten voor vertrek
+  worden ontvangen
 * Vertalingen bijgewerkt
 
 ## 1.4.2
@@ -43,7 +55,8 @@
 
 ## 1.2.5
 
-* Verwerken berichten gebeurt op aparte worker thread (voorkomt verloren berichten bij DVS bursts)
+* Verwerken berichten gebeurt op aparte worker thread (voorkomt verloren
+  berichten bij DVS bursts)
 * ZeroMQ HWM (high water mark) op onbeperkt gezet
 * Vertalingen bijgewerkt
 * Kleine bugfixes, code opgeschoond
@@ -65,9 +78,11 @@
 
 ## 1.2.1
 
-* Aantal extra vertalingen naar Engels voor oorzakentabel (opgeheven/vertraagde treinen)
+* Aantal extra vertalingen naar Engels voor oorzakentabel
+  (opgeheven/vertraagde treinen)
 * Treinnaam verhuisd naar treintips (HTTP interface)
-* Vertaalde treinnaam bij IC Direct (waar treinnaamveld wordt misbruikt voor toeslaginfo)
+* Vertaalde treinnaam bij IC Direct (waar treinnaamveld wordt misbruikt
+  voor toeslaginfo)
 
 ## 1.2.0a
 
@@ -116,7 +131,8 @@
 ## 1.0.1
 
 * Munin plugins toegevoegd
-* Grootte van trein- en stationstores en berichtenteller toegevoegd als ZMQ commando
+* Grootte van trein- en stationstores en berichtenteller toegevoegd als
+  ZMQ commando
 * Diverse wijzigingsoorzaken vertaald naar Engels
 
 ## 1.0.0

README.md

@@ -155,15 +155,11 @@ Het is mogelijk om de host en poort aan te passen met de parameters `--server` e
 
 ### HTTP interface
 
-De HTTP interface kan voor ontwikkeldoeleinden gestart worden met de tool `dvs-http.py`. Deze tool start een [Bottle](http://bottlepy.org/docs/dev/index.html) ontwikkelserver op http://localhost:8080/ (of optioneel op een andere host/poort-combinatie). Voor productiedoeleinden kun je de WSGI-koppeling in `dvs-http.wsgi` gebruiken.
-
-De HTTP-interface ontsluit een JSON webservice die reageert op de volgende URL's:
+RDT infoplus-dvs biedt een REST API aan voor het opvragen van vertrektijden en ritdetails. De API is beschreven in het document [HTTP interface](doc/http-interface.md) en in de [OpenAPI definitie](doc/http-interface.yaml).
 
-* `/station/<stationcode>` en `/station/<stationcode>/<taal>` - Geeft de vertrektijden per station terug. Specificeer optioneel 'nl' of 'en' als taalcode om wijzigingen en dergelijke te vertalen (standaard is Nederlands). Optionele parameters: `sorteer` met mogelijke waarden 'gepland', 'actueel', 'vertrek', of 'vertraging', en `verbose` (indien de waarde 'true' is wordt meer informatie teruggegeven).
-* `/trein/<treinnummer>/<stationcode>` en `/trein/<treinnummer>/<stationcode>` - Geeft uitgebreide verbose per trein op een bepaald station terug, zoals de route per treinvleugel.
-* `/status` - Geeft de systeemstatus terug (UP, DOWN, UNKNOWN of RECOVERING) en eventuele starttijd van downtime en recovertijd.
+De HTTP interface kan voor ontwikkeldoeleinden gestart worden met de tool `dvs-http.py`. Deze tool start een [Bottle](http://bottlepy.org/docs/dev/index.html) ontwikkelserver op http://localhost:8080/ (of optioneel op een andere host/poort-combinatie). Voor productiedoeleinden kun je de WSGI-koppeling in `dvs-http.wsgi` gebruiken.
 
-De HTTP-interface kan op een andere server draaien dan de daemon zelf. In het WSGI-bestand wordt de host ingesteld waarmee verbinding gemaakt wordt.
+De HTTP-interface kan op een andere server draaien dan de daemon zelf. Optioneel kan de HTTP-interface gekoppeld worden aan [rdt-serviceinfo](https://github.com/geertw/rdt-serviceinfo) voor het verrijken van de routestops met vertrek- en aankomsttijden, en voor het opvragen van ritten die niet (meer) in DVS zitten.
 
 Aandachtspunten
 ---------------

config/dvs-server.yaml.dist

@@ -14,15 +14,16 @@ logging:
 # Tenzij instellingen voor downtimedetectie en GC ingesteld worden, worden
 # de standaardinstellingen overgenomen
 #downtime_detection:
-#  count_time_window: 10   # meet downtime over periode van 10 minuten
-#  count_threshold: 1      # er moet minstens 1 bericht per minuut gedetecteerd zijn (gemiddeld)
-#  recovery_time: 70       # status is hersteld 70 minuten zonder downtime
+#  count_time_window: 10       # meet downtime over periode van 10 minuten
+#  count_threshold: 1          # er moet minstens 1 bericht per minuut gedetecteerd zijn (gemiddeld)
+#  recovery_time: 70           # status is hersteld 70 minuten zonder downtime
 
 #garbage_collection:
-#  gc_threshold: 10        # wis treinen zonder vertrekbericht 10 minuten na vertrektijd
-#  gc_threshold_static: 0  # wis geinjecteerde ritten 0 minuten na vertrektijd
+#  gc_threshold: 10            # markeer treinen zonder vertrekbericht 10 minuten na vertrektijd als vertrokken
+#  gc_threshold_static: 0      # markeer geinjecteerde ritten 0 minuten na vertrektijd als vertrokken
+#  gc_threshold_departed: 120  # vertrokken treinen 120 minuten na vertrek bewaren
 
 # Debugopties
 #debug:
-#  keep_departures: true   # vertrokken ritten niet wissen
+#  keep_departures: true       # vertrokken ritten geheel niet wissen
 ...