XMLRPC API documentation issues
Posted: Thu Aug 06, 2020 8:43 pm
I am a developer on mpc-hc (clsid2 fork, the current active fork installed with klite codec pack). I have been trying to make an improvement to the subtitle search capability, and have run into some issues.
1. Documentation is inconsistent on trac:
https://trac.opensubtitles.org/projects ... iki/XMLRPC
On this page, the api is defined for SearchSubtitles with parameters (including "tag"):
But at the top of the page, it suggests this link for better examples:
https://trac.opensubtitles.org/projects ... mlRpcIntro
Note the two signatures are different, leading to possible confusion. This leads me to #2.
2. It seems tag search support is silently disabled, and just doesn't work.
I found a post from 2018 or 2019 saying it was disabled for performance reasons. It took me a while to find that post. Yet, the documentation states nothing about that. With two distinct signatures on the trac pages, it's enough to make you wonder if the "tag" doesn't belong in the api any longer--or are you just using it wrong? Yet, the page that mentions "tag" search is actually updated more recently.
As for performance reasons, the result of disabling tag support is, I can no longer do video filename search. This forces me to use "query" instead, and then filter the results. That must be a bigger performance hit than just searching by tag, right? Even with an exact filename, the first result is usually the right one, but is followed by 499 "close" results that I just throw away.
Is there any hope for a strict filename search, or return of tag search? It makes me sad to do such an inefficient query just because of nebulous "performance" concerns.
1. Documentation is inconsistent on trac:
https://trac.opensubtitles.org/projects ... iki/XMLRPC
On this page, the api is defined for SearchSubtitles with parameters (including "tag"):
Code: Select all
array SearchSubtitles( $token, array(array('sublanguageid' => $sublanguageid, 'moviehash' => $moviehash, 'moviebytesize' => $moviesize, imdbid => $imdbid, query => 'movie name', "season" => 'season number', "episode" => 'episode number', 'tag' => tag ),array(...)), array('limit' => 500))https://trac.opensubtitles.org/projects ... mlRpcIntro
Code: Select all
struct SearchSubtitles(string $token, array(struct('sublanguageid' => string $sublanguageid, 'moviehash' => string $moviehash, 'moviebytesize' => int $moviesize, 'imdbid' => string $imdbid ), struct(...)))2. It seems tag search support is silently disabled, and just doesn't work.
I found a post from 2018 or 2019 saying it was disabled for performance reasons. It took me a while to find that post. Yet, the documentation states nothing about that. With two distinct signatures on the trac pages, it's enough to make you wonder if the "tag" doesn't belong in the api any longer--or are you just using it wrong? Yet, the page that mentions "tag" search is actually updated more recently.
As for performance reasons, the result of disabling tag support is, I can no longer do video filename search. This forces me to use "query" instead, and then filter the results. That must be a bigger performance hit than just searching by tag, right? Even with an exact filename, the first result is usually the right one, but is followed by 499 "close" results that I just throw away.
Is there any hope for a strict filename search, or return of tag search? It makes me sad to do such an inefficient query just because of nebulous "performance" concerns.
