search

pymedusa / Medusa

Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
https://pymedusa.com
GNU General Public License v3.0
1.77k stars 275 forks source link

Lack of some API documentation #7776

Open Merrick28 opened 4 years ago

Merrick28 commented 4 years ago

Hello all,

Is your feature request related to a problem? Please describe. It is related to API. It's not a problem with medusa, but for external tools (linked to https://github.com/Boerderij/Varken/issues/172) Some of Medusa API are not documented

Describe the solution you'd like It would be nice to document all API, so external tools can work (for exemple Varken). For example : https:///api/ For now, only api/v2 seems documented (https://medusaapi.docs.apiary.io/#reference/0//api/v2/series)

p0psicles commented 4 years ago

The old api is documented through the /apibuilder endpoint. But we don't spend any time on that. If we document something we'll do it for apiv2

medariox commented 4 years ago

Which endpoint are you using? The API v1 should be identical to any other Sickbeard fork.

Merrick28 commented 4 years ago

I'm using /api?cmd=future. On sickchill, the "snatched" type works (see on my first post, the issue opened un Varken), but not in Medusa. On sickbeard, only types downloaded and snatched are supported. On medusa, you can use missed, today, soon, later.

@p0psicles I understand your point. Do you think there will be a v2 api to get snatched/missed/soon episodes ?

p0psicles commented 4 years ago

Eventually yes it well. Probably will be worked on when we tradition the scheduled page to Vue.