Update api description template to include apikey in links

This commit is contained in:
DariusIII
2018-05-21 15:21:11 +02:00
parent 2d853cc039
commit 35cdcaa319
2 changed files with 10 additions and 9 deletions
+1
View File
@@ -1,4 +1,5 @@
2018-05-21 DariusIII
* Chg: Update api description template to include apikey in links
* Fix: Prevent duplicated 'All' on browse all releases
* Chg: Add .editorconfig file
* Fix: Fix errors in full series view
+9 -9
View File
@@ -19,23 +19,23 @@
credentials in order to be ran.
</dd>
<br>
<dt>Search <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=search&amp;q=linux">?t=search&amp;q=linux</a></span>
<dt>Search <span style="font-family:courier;"><a href="{$smarty.const.WWW_TOP}/api/v1/api?t=search&amp;q=linux&amp;apikey={$userdata.rsstoken}">?t=search&amp;q=linux</a></span>
</dt>
<dd>Returns a list of nzbs matching a query. You can also filter by site category by including a comma separated
list of categories as follows <span style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api?t=search&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}">?t=search&amp;cat={$catClass::GAME_ROOT}
href="{$smarty.const.WWW_TOP}/api?t=search&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}&amp;apikey={$userdata.rsstoken}">?t=search&amp;cat={$catClass::GAME_ROOT}
,{$catClass::MOVIE_ROOT}</a></span>. Include <span
style="font-family:courier;">&amp;extended=1</span> to return extended information in the search
results.
</dd>
<br>
<dt>TV <span style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api/v1/api?t=tvsearch&amp;q=law%20and%20order&amp;season=7&amp;ep=12">?t=tvsearch&amp;q=law and order&amp;season=7&amp;ep=12</a></span>
href="{$smarty.const.WWW_TOP}/api/v1/api?t=tvsearch&amp;q=law%20and%20order&amp;season=7&amp;ep=12&amp;apikey={$userdata.rsstoken}">?t=tvsearch&amp;q=law and order&amp;season=7&amp;ep=12</a></span>
</dt>
<dd>Returns a list of nzbs matching a query, category, tvrageid, season or episode.
You can also filter by site category by including a comma separated list of categories as follows:
<span style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api/v1/api?t=tvsearch&amp;rid=2204&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}">?t=tvsearch&amp;cat={$catClass::GAME_ROOT}
href="{$smarty.const.WWW_TOP}/api/v1/api?t=tvsearch&amp;rid=2204&amp;cat={$catClass::GAME_ROOT},{$catClass::MOVIE_ROOT}&amp;apikey={$userdata.rsstoken}">?t=tvsearch&amp;cat={$catClass::GAME_ROOT}
,{$catClass::MOVIE_ROOT}</a></span>.
Include <span style="font-family:courier;">&amp;extended=1</span> to return extended information in the
search results.
@@ -47,28 +47,28 @@
</dd>
<br>
<dt>Movies <span style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api/v1/api?t=movie&amp;imdbid=1418646">?t=movie&amp;imdbid=1418646</a></span>
href="{$smarty.const.WWW_TOP}/api/v1/api?t=movie&amp;imdbid=1418646&amp;apikey={$userdata.rsstoken}">?t=movie&amp;imdbid=1418646</a></span>
</dt>
<dd>Returns a list of nzbs matching a query, an imdbid and optionally a category. Filter by
site category by including a comma separated list of categories as follows <span
style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api/v1/api?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD},{$catClass::MOVIE_HD}">?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD}
href="{$smarty.const.WWW_TOP}/api/v1/api?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD},{$catClass::MOVIE_HD}&amp;apikey={$userdata.rsstoken}">?t=movie&amp;imdbid=1418646&amp;cat={$catClass::MOVIE_SD}
,{$catClass::MOVIE_HD}</a></span>. Include <span style="font-family:courier;">&amp;extended=1</span>
to return extended information in the search results.
</dd>
<br>
<dt>Details <span style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api/v1/api?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span>
href="{$smarty.const.WWW_TOP}/api/v1/api?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda&amp;apikey={$userdata.rsstoken}">?t=details&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span>
</dt>
<dd>Returns detailed information about an nzb.</dd>
<br>
<dt>Info <span style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api/v1/api?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span>
href="{$smarty.const.WWW_TOP}/api/v1/api?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda&amp;apikey={$userdata.rsstoken}">?t=info&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span>
</dt>
<dd>Returns NFO contents for an NZB. Retrieve the NFO as file by specifying o=file in the request URI.</dd>
<br>
<dt>Get <span style="font-family:courier;"><a
href="{$smarty.const.WWW_TOP}/api/v1/api?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda">?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span>
href="{$smarty.const.WWW_TOP}/api/v1/api?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda&amp;apikey={$userdata.rsstoken}">?t=get&amp;id=9ca52909ba9b9e5e6758d815fef4ecda</a></span>
</dt>
<dd>Downloads the nzb file associated with an Id.</dd>
</dl>