search

RuterNo / adt-doc

Documentation intended for PTOs who need to connect to Ruters digitale plattform
Apache License 2.0
4 stars 0 forks source link

Prefix for topic pe/vehicle/api #213

Open mariusw opened 5 months ago

mariusw commented 5 months ago

Pre-ADT3 var strukturen for dette topicet {operator}/ruter/{vehicleid}/pe/vehicle/api mens i ADT3 er den {operator}/ruter/{vehicleid}/adt/v3/pe/vehicle/api

Innholdet i denne meldingen er selve versjonen, så for meg er det ulogisk at versjonen også skal ligge som en del av prefikset i topic-navnet. Før man leser meldingen så vet man jo ikke hvilken versjon man er på. Det kan man selvsagt løse ved å subscribe på adt/+/pe/vehicle/api, så vil man fange opp alle fremtidige versjoner her, men utfordringen er at vi har både kjøretøy på ADT2 (og da er topicet uten adt/vx/), og "ADT1" (Romerike osv) (der versjonsnr i meldingen vil være "1"). Dette topicet er også uten prefix.

Jeg foreslår at pe/vehicle/api alltid produseres uten prefix, slik at vi fanger opp alle versjoner f.o.m. ADT1 i samme topic i all fremtid.

RolfErik-Ruter commented 5 months ago

Er ikke det en breaking change å endre? Siden operatørene bruker ADT3.

Uansett, selv om versjonen er i meldingen, så vet du jo ikke hvilken minor versjon det er ? Og er veldig vanlig, uhavenning hva slags tjeneste det er, å ha major versjon i navnet? Følger semantic versioning veldig fint. Dermed er formatet på alle tjeneste likestilt innad samme major versjon. I "terorien" skal jo alle de andre versjonen dø og med ADT4 så er det fortsatt lett å skille mellom versjonene.

mariusw commented 5 months ago

Jeg ser nå at PÅ BUSSEN er topics aldri prefikset, så da er dette ikke et så presserende punkt for oss. Det er bridge-configen som legger på /adt/v3/ som prefiks når de sendes videre fra buss til Ruters broker.

Helt enig i at å ha major version i navnet gir mening for de fleste topics, men synes det gir lite mening i akkurat det aktuelle topicet (som er det som varsler hvilken versjon det er).

mariusw commented 5 months ago

Det er vel antakelig en breaking change, så det måtte i så fall bli endret til ADT4