OpenAPI och mindre synpunkter på dokumentationen

[pek...@gmail.com]

Hej

Jag har suttit och lusläs dokumentationen för det öppna API:et och har försökt skapa en OpenAPI specifikation. Jag har lagt upp detta på GitHub, säg till om ni har några synpunkter:

https://github.com/pekspro/SwedRadioAPITools

När jag har gjort detta har jag hittat en del småsaker som jag tror är fel i dokumentation eller i implementationen. Absolut ingenting av detta ser jag som viktigt :-). Men jag sammanställer ändå detta här, ni kanske tycker det är värt att titta på.

Program: https://sverigesradio.se/api/documentation/v2/metoder/program.html

• programcategory är inte med i svaret, om man inte filtrerar på kategori. Jämför dessa:
  
  • https://api.sr.se/api/v2/programs?format=json&programCategoryId=5
  • https://api.sr.se/api/v2/programs?format=json

Grupper: https://sverigesradio.se/api/documentation/v2/metoder/grupp.html

• Går det att få fram alla episodegroup?
• Den här episodegruppen:
  http://api.sr.se/api/v2/episodes/group?id=23037
  Innehåller episod 751937, Men den i sin tur har ingen information om gruppen:
  http://api.sr.se/api/v2/episodes/751937
  
• Formatet på availablefromutc ser inte rätt ut:
  http://api.sr.se/api/v2/episodes/group?id=23037 

Musik: https://sverigesradio.se/api/documentation/v2/metoder/musik.html

• I playlists/getplaylistbyprogramid så fungerar inte size-parametern:
  https://api.sr.se/api/v2/playlists/getplaylistbyprogramid?format=json&id=2697&startDateTime=2011-01-01&endDateTime=2021-04-06&size=5
  
  Fungerar dock för getplaylistbychannelid:
  http://api.sr.se/api/v2/playlists/getplaylistbychannelid?id=132&startdatetime=2021-01-01&enddatetime=2021-01-02&size=3
  
  
• För playlists/getplaylistbyepisodeid så står det att det ska gå att filtrera på start- och slutdatum. Detta verkar inte fungera (ser inte heller något syfte med att det skulle fungera :-):
  
  http://api.sr.se/api/v2/playlists/getplaylistbyepisodeid?id=422962&startdatetime=2021-01-01&enddatetime=2021-01-02&size=3

Topplistor: https://sverigesradio.se/api/documentation/v2/metoder/topplistor.html

• Är Toppuffar nedlagt? Man får alltid en tom lista här:
  http://api.sr.se/api/v2/topstories

Trafik: https://sverigesradio.se/api/documentation/v2/metoder/trafik.html

• Det står i dokumentationen att det ska gå att filtrera på datum men det verkar inte fungera:
  
  http://api.sr.se/api/v2/traffic/messages?date=2021-07-04