@golemio/pid 2.17.1-dev.1412857437 → 2.18.0-rc.1418092579

package/docs/implementation_documentation.md

@@ -23,7 +23,6 @@ Modul slouží k ukládání a poskytování informací o jízdních řádech a
     -   Kolejové obvody pro metro
 -   Grafana Loki
     -   Request logy z URL proxy pro monitorovací centrum od ROPIDU
--   JIS Infotexty
 
 #### _ROPID FTP (obecně)_
 
@@ -215,25 +214,7 @@ _:warning: Původním záměrem bylo využití OIS číselníku během zpracová
             -   prod `0 */1 * * * *`
 -   názvy rabbitmq front
     -   vehicle-positions.ropidpresets.collectAndSaveLogs se zprávou `{ "targetMinutes": n }`
-
-#### _JIS Infotexty_
-
--   zdroj dat
-    -   baseUrl: module.pid.jis.baseUrl
-    -   infotexts path: module.pid.jis.infotexts.path
-    -   hlavičky infotexts dotazu: module.pid.jis.infotexts.headers
--   formát dat
-    -   protokol: http
-    -   datový typ: json
-    -   validační schéma: [JISInfotextsJsonSchema](../src/schema-definitions/jis/datasources/JISInfotextsJsonSchema.ts)
-    -   příklad vstupnich dat: [infotextsDataSourceFixture](../test/integration-engine/jis/fixtures/infotextsDataSourceFixture.ts)
--   frekvence stahování
-    -   cron definice:
-        -   cron.vehicle-positions.jis.refreshJISInfotexts
-            -   rabin `*/30 * * * * *`
-            -   prod `*/30 * * * * *`
--   název rabbitmq fronty
-    -   vehicle-positions.jis.refreshJISInfotexts
+-   
 
 ### _Ropid staticka data_
 
@@ -244,7 +225,7 @@ _:warning: Původním záměrem bylo využití OIS číselníku během zpracová
 -   formát dat
     -   protokol: http
     -   datový typ: csv
-    -   validační schéma:
+    -   validační schéma: 
         -   [MetroRailTrack](../src/schema-definitions/datasources/static-data/MetroRailTrackJsonSchema.ts)
         -   [DeparturesDirection](../src/schema-definitions/datasources/static-data/DeparturesDirectionsJsonSchema.ts)
     -   příklad vstupnich dat: viz zdroj data
@@ -252,7 +233,6 @@ _:warning: Původním záměrem bylo využití OIS číselníku během zpracová
     -   Po nacteni jizdnich radu (fronta: vehicle-positions.ropidgtfs.checkForNewData)
 -   názvy rabbitmq front
     -    vehicle-positions.ropidgtfs.saveStaticData
-
 ### Data nám jsou posílána
 
 **Dostupní poskytovatelé**:
@@ -1105,26 +1085,6 @@ Worker má na starost retenci dat tabulek Azure Table Storage
 -   data modely
     -   žádné
 
-### _JISWorker_
-
-Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a uložení do databáze
-
-#### _task: RefreshJISInfotextsTask_
-
--   vstupní rabbitmq fronta
-    -   název: vehicle-positions.jis.refreshJISInfotexts
-    -   TTL: 1 minuta
-    -   parametry: žádné
--   závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
-    -   žádné
--   datové zdroje
-    -   JIS Infotexty
--   transformace
-    -   [JISInfotextsTransformation](../src/integration-engine/jis/transformations/JISInfotextsTransformation.ts)
--   data modely
-    -   JISInfotextsModel `jis_infotexts`
-    -   JISInfotextsRopidGTFSStopsModel `jis_infotexts_ropidgtfs_stops`
-
 ## Uložení dat
 
 -   typ databáze
@@ -1149,15 +1109,12 @@ Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a u
         ![pid vp desc diagram](./assets/pid_vp_desc_erd.png)
     -   Zastávky RT spojů (pouze MPV)<br/>
         ![pid vp cis  diagram](./assets/pid_vp_cis_erd.jpg)
-    -   JIS infotexty<br/>
-        ![pid jis diagram](./assets/pid_jis_erd.png)
 
 -   retence dat
     -   jízdní řády se generují 1-2x denně na 14 dní dopředu
     -   polohová data si uchováváme 24 hodin (30 minut od poslední aktualizace, poté v historických tabulkách)
     -   popis vozidel si uchováváme 24 hodin
     -   preset logy si uchováváme 8 hodin
-    -   JIS infotexty si uchováváme do příštího úspěšného znovunačtení (ke kterému by mělo docházet dvakrát za minutu)
 
 ## Input API
 
@@ -1165,8 +1122,8 @@ Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a u
 
 -   OpenAPI v3 dokumentace
     -   zdrojový soubor: [openapi-input.yaml](./openapi-input.yaml)
-    -   rabin: https://rabin.golemio.cz/pid/input-gateway/docs/openapi/
-    -   golem: https://api.golemio.cz/pid/input-gateway/docs/openapi/
+    -   rabin: https://rabin.golemio.cz/v2/pid/input/docs/openapi/
+    -   golem: https://api.golemio.cz/v2/pid/input/docs/openapi/
 -   api je neveřejné
 -   postman kolekce
     -   TBD
@@ -1193,64 +1150,64 @@ Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a u
 
 -   OpenAPI v3 dokumentace
     -   zdrojový soubor: [openapi-output.yaml](./openapi-output.yaml)
-    -   rabin: https://rabin.golemio.cz/pid/docs/openapi/
-    -   golem: https://api.golemio.cz/pid/docs/openapi/
--   GTFS-RT a `/v2/public` data jsou veřejná, zbývající endpointy jsou k dispozici všem registrovaným uživatelům
+    -   rabin: https://rabin.golemio.cz/v2/pid/docs/openapi/
+    -   golem: https://api.golemio.cz/v2/pid/docs/openapi/
+-   real-time data jsou veřejná, zbývající endpointy jsou k dispozici všem registrovaným uživatelům
 -   postman kolekce
     -   TBD
 
-### GTFS v2
+### GTFS
 
-#### _/v2/gtfs/services_
+#### _/gtfs/services_
 
 -   zdrojové tabulky
     -   `ropidgtfs_calendar`
 
-#### _/v2/gtfs/routes_
+#### _/gtfs/routes_
 
 -   zdrojové tabulky
     -   `ropidgtfs_routes`
 
-#### _/v2/gtfs/routes/{id}_
+#### _/gtfs/routes/{id}_
 
 -   zdrojové tabulky
     -   `ropidgtfs_routes`
 
-#### _/v2/gtfs/trips_
+#### _/gtfs/trips_
 
 -   zdrojové tabulky
     -   `ropidgtfs_trips`, `ropidgtfs_stop_times`, `ropidgtfs_calendar`
 
-#### _/v2/gtfs/trips/{id}_
+#### _/gtfs/trips/{id}_
 
 -   zdrojové tabulky
     -   `ropidgtfs_trips`, `ropidgtfs_stop_times`, `ropidgtfs_stops`, `ropidgtfs_shapes`, `ropidgtfs_calendar`, `ropidgtfs_routes`
 
-#### _/v2/gtfs/shapes/{id}_
+#### _/gtfs/shapes/{id}_
 
 -   zdrojové tabulky
     -   `ropidgtfs_shapes`
 
-#### _/v2/gtfs/stops_
+#### _/gtfs/stops_
 
 -   zdrojové tabulky
     -   `ropidgtfs_stops`, `ropidgtfs_cis_stops`
 -   dodatečná transformace: Feature collection
 
-#### _/v2/gtfs/stops/{id}_
+#### _/gtfs/stops/{id}_
 
 -   zdrojové tabulky
     -   `ropidgtfs_stops`, `ropidgtfs_cis_stops`
 -   dodatečná transformace: Feature
 
-#### _/v2/gtfs/stoptimes/{id}_
+#### _/gtfs/stoptimes/{id}_
 
 -   zdrojové tabulky
     -   `ropidgtfs_stop_times`, `ropidgtfs_stops`, `ropidgtfs_calendar`, `ropidgtfs_trips`
 
-### Vehicle Positions v2
+### Vehicle Positions
 
-#### _/v2/vehiclepositions_
+#### _/vehiclepositions_
 
 -   zdrojové tabulky
     -   `v_vehiclepositions_all_trips_with_last_position` (`vehiclepositions_positions`, `vehiclepositions_trips`)
@@ -1259,7 +1216,7 @@ Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a u
 -   dodatečná transformace: Feature collection
 -   je použit `CompressionByDefaultMiddleware` a odpovědi jsou tak na output gateway komprimovány i pokud klient explicitně nepovolí komprimaci vhodnou hodnotou hlavičky `Accept-Encoding` (lze však komprimaci explicitně zakázat hodnotou `identity`)
 
-#### _/v2/vehiclepositions/{gtfsTripId}_
+#### _/vehiclepositions/{gtfsTripId}_
 
 -   zdrojové tabulky
     -   `v_vehiclepositions_all_trips_with_last_position` (`vehiclepositions_positions`, `vehiclepositions_trips`)
@@ -1269,51 +1226,43 @@ Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a u
 -   dodatečná transformace: Feature
 -   je použit `CompressionByDefaultMiddleware` a odpovědi jsou tak na output gateway komprimovány i pokud klient explicitně nepovolí komprimaci vhodnou hodnotou hlavičky `Accept-Encoding` (lze však komprimaci explicitně zakázat hodnotou `identity`)
 
-### Vehicle Positions GTFS RT v2
+### Vehicle Positions GTFS RT
 
-#### _/v2/vehiclepositions/gtfsrt/trip_updates.pb_
+#### _/vehiclepositions/gtfsrt/trip_updates.pb_
 
 -   načtení souboru z Redis cache
     -   HGET files:gtfsRt trip_updates.pb
 
-#### _/v2/vehiclepositions/gtfsrt/vehicle_positions.pb_
+#### _/vehiclepositions/gtfsrt/vehicle_positions.pb_
 
 -   načtení souboru z Redis cache
     -   HGET files:gtfsRt vehicle_positions.pb
 
-#### _/v2/vehiclepositions/gtfsrt/pid_feed.pb_
+#### _/vehiclepositions/gtfsrt/pid_feed.pb_
 
 -   načtení souboru z Redis cache
     -   HGET files:gtfsRt pid_feed.pb
 
-#### _/v2/vehiclepositions/gtfsrt/alerts.pb_
+#### _/vehiclepositions/gtfsrt/alerts.pb_
 
 -   načtení souboru z Redis cache
     -   HGET files:gtfsRt alerts.pb
 
-### PID Departure Boards v2
+### PID Departure Boards
 
-#### _/v2/pid/departureboards_
+#### _/pid/departureboards_
 
 -   zdrojové tabulky
-    -   `ropidgtfs_precomputed_departures`, `ropidgtfs_stops`, `ropidgtfs_cis_stops`, `jis_infotexts`, `jis_infotexts_ropidgtfs_stops`, `ropid_departures_directions`, `vehiclepositions_positions`, `vehiclepositions_trips`
+    -   `ropidgtfs_precomputed_departures`, `ropidgtfs_stops`, `ropidgtfs_cis_stops`, `ropidvymi_events`, `ropidvymi_events_stops`, `ropid_departures_directions`, `vehiclepositions_positions`, `vehiclepositions_trips`
 
-#### _/v2/pid/infotexts_
+#### _/pid/infotexts_
 
 -   zdrojové tabulky
     -   `ropidvymi_events`, `ropidvymi_events_stops`, `ropidvymi_events_routes`, `ropidgtfs_stops`
 
-### PID Departure Boards v3
-
-#### _/v3/pid/infotexts_
-
--  načte aktivní infotexty exportované z aplikace VYMI (JIS) Infotexty
--  zdrojové tabulky
-    -   `jis_infotexts`, `jis_infotexts_ropidgtfs_stops`, `ropidgtfs_stops`
-
-### Public v2
+### Public
 
-#### _/v2/public/gtfs/trips/{gtfsTripId}_
+#### _/public/gtfs/trips/{gtfsTripId}_
 
 -   načte statické informace o GTFS spoji z PSQL, případně jeho oběhové číslo pro současný den (pokud je k dispozici), shapes a zastávky
     -   `info`: statické informace o GTFS spoji a jeho oběhové číslo pro současný den (pokud je k dispozici)
@@ -1323,14 +1272,14 @@ Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a u
 -   cachováno na 4 hodiny pomocí cache-control hlavičky
 -   je použit `CompressionByDefaultMiddleware` a odpovědi jsou tak na output gateway komprimovány i pokud klient explicitně nepovolí komprimaci vhodnou hodnotou hlavičky `Accept-Encoding` (lze však komprimaci explicitně zakázat hodnotou `identity`)
 
-#### _/v2/public/vehiclepositions_
+#### _/public/vehiclepositions_
 
 -   načte aktuální polohy vozidel z redisu a vrátí je ve formátu geojson
     -   možno filtrovat dle bouding box na straně redisu
     -   podle typu vozidla a gtfs route number na klientské straně
 -   je použit `CompressionByDefaultMiddleware` a odpovědi jsou tak na output gateway komprimovány i pokud klient explicitně nepovolí komprimaci vhodnou hodnotou hlavičky `Accept-Encoding` (lze však komprimaci explicitně zakázat hodnotou `identity`)
 
-#### _/v2/public/vehiclepositions/{vehicleId}_
+#### _/public/vehiclepositions/{vehicleId}_
 
 -   načte jednu aktuální polohu z redisu
     -   výstup možno filtrovat podle query parametru `scopes`
@@ -1340,12 +1289,12 @@ Worker má na starost stahování VYMI (JIS) infotextů, jejich transformaci a u
     -   `vehicle_descriptor`: informace o vozidle (dopravce, dostupnost klimatizace, USB, ...)
 -   je použit `CompressionByDefaultMiddleware` a odpovědi jsou tak na output gateway komprimovány i pokud klient explicitně nepovolí komprimaci vhodnou hodnotou hlavičky `Accept-Encoding` (lze však komprimaci explicitně zakázat hodnotou `identity`)
 
-#### _/v2/public/vehiclepositions/{vehicleId}{gtfsTripId}_
+#### _/public/vehiclepositions/{vehicleId}{gtfsTripId}_
 
 -   rozšíření endpointu výše `/public/vehiclepositions/{vehicleId}` o možnost dotázat se na before track (delayed) spoje podle `gtfsTripId`
 -   je použit `CompressionByDefaultMiddleware` a odpovědi jsou tak na output gateway komprimovány i pokud klient explicitně nepovolí komprimaci vhodnou hodnotou hlavičky `Accept-Encoding` (lze však komprimaci explicitně zakázat hodnotou `identity`)
 
-#### _/v2/public/departureboards_
+#### _/public/departureboards_
 
 -   načte nacacheované odjezdy z redisu
     - možno filtrovat podle skupin zastávek `stopIds` (podle GTFS číselníku) s možností nastavení pořadí navrácených skupin s odjezdy - příklad `?stopIds[]={"0": ["U717Z5P"]}&stopIds[]={"1": ["U718Z5P", "U719Z5P"]}`

package/docs/index.md

@@ -0,0 +1,3 @@
+# @golemio/pid
+
+This module is intended for use with Golemio services. Refer [here](https://gitlab.com/operator-ict/golemio/code/modules/core/-/blob/development/README.md) for further information on usage, local development and more.