Skip to content

Commit 5185809

Browse files
authored
Fixed layout of linked TheTVDB.com API routes in the README.md 'Features' section
1 parent 870681f commit 5185809

File tree

1 file changed

+70
-43
lines changed

1 file changed

+70
-43
lines changed

README.md

Lines changed: 70 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -46,48 +46,75 @@ of the RESTful API might not always be backwards compatible, each major `thetvdb
4646
to a specific version of the _TheTVDB.com_ remote API. The API version a specific connector release is using can be derived
4747
from its version number. For example, `v3.x` uses the _TheTVDB.com_ APIv3 whereas the (not yet existent) `v4.x` would use
4848
the upcoming APIv4.
49-
50-
<details><summary>Supported _TheTVDB.com_ APIv3 routes (`thetvdb-java-api v3.x`)</summary>
51-
- Authentication
52-
+ [/login](https://api.thetvdb.com/swagger#!/Authentication/post_login)
53-
+ [/refresh_token](https://api.thetvdb.com/swagger#!/Authentication/get_refresh_token)
54-
- Episodes
55-
+ [/episodes/{id}](https://api.thetvdb.com/swagger#!/Episodes/get_episodes_id)
56-
- Languages
57-
+ [/languages](https://api.thetvdb.com/swagger#!/Languages/get_languages)
58-
+ [/languages/{id}](https://api.thetvdb.com/swagger#!/Languages/get_languages_id)
59-
- Movies
60-
+ [/movies/{id}](https://api.thetvdb.com/swagger#!/Movies/get_movies_id)
61-
+ [/movieupdates](https://api.thetvdb.com/swagger#!/Movies/get_movieupdates)
62-
- Search
63-
+ [/search/series](https://api.thetvdb.com/swagger#!/Search/get_search_series)
64-
+ [/search/series/params](https://api.thetvdb.com/swagger#!/Search/get_search_series_params)
65-
- Series
66-
+ [/series/{id}](https://api.thetvdb.com/swagger#!/Series/get_series_id)
67-
+ [/series/{id}](https://api.thetvdb.com/swagger#!/Series/head_series_id) (HEAD)
68-
+ [/series/{id}/actors](https://api.thetvdb.com/swagger#!/Series/get_series_id_actors)
69-
+ [/series/{id}/episodes](https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes)
70-
+ [/series/{id}/episodes/query](https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes_query)
71-
+ [/series/{id}/episodes/query/params](https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes_query_params)
72-
+ [/series/{id}/episodes/summary](https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes_summary)
73-
+ [/series/{id}/filter](https://api.thetvdb.com/swagger#!/Series/get_series_id_filter)
74-
+ [/series/{id}/filter/params](https://api.thetvdb.com/swagger#!/Series/get_series_id_filter_params)
75-
+ [/series/{id}/images](https://api.thetvdb.com/swagger#!/Series/get_series_id_images)
76-
+ [/series/{id}/images/query](https://api.thetvdb.com/swagger#!/Series/get_series_id_images_query)
77-
+ [/series/{id}/images/query/params](https://api.thetvdb.com/swagger#!/Series/get_series_id_images_query_params)
78-
- Updates
79-
+ [/updated/query](https://api.thetvdb.com/swagger#!/Updates/get_updated_query)
80-
+ [/updated/query/params](https://api.thetvdb.com/swagger#!/Updates/get_updated_query_params)
81-
- Users
82-
+ [/user](https://api.thetvdb.com/swagger#!/Users/get_user)
83-
+ [/user/favorites](https://api.thetvdb.com/swagger#!/Users/get_user_favorites)
84-
+ [/user/favorites/{id}](https://api.thetvdb.com/swagger#!/Users/delete_user_favorites_id) (DELETE)
85-
+ [/user/favorites/{id}](https://api.thetvdb.com/swagger#!/Users/put_user_favorites_id) (PUT)
86-
+ [/user/ratings](https://api.thetvdb.com/swagger#!/Users/get_user_ratings)
87-
+ [/user/ratings/query](https://api.thetvdb.com/swagger#!/Users/get_user_ratings_query)
88-
+ [/user/ratings/query/params](https://api.thetvdb.com/swagger#!/Users/get_user_ratings_query_params)
89-
+ [/user/ratings/{itemType}/{itemId}](https://api.thetvdb.com/swagger#!/Users/delete_user_ratings_itemType_itemId)
90-
+ [/user/ratings/{itemType}/{itemId}/{itemRating}](https://api.thetvdb.com/swagger#!/Users/put_user_ratings_itemType_itemId_itemRating)
49+
50+
<details><summary>Supported _TheTVDB.com_ APIv3 routes (<code>thetvdb-java-api v3.x</code>)</summary>
51+
<p>
52+
<ul>
53+
<li>Authentication
54+
<ul>
55+
<li><a href="https://api.thetvdb.com/swagger#!/Authentication/post_login">/login</a></li>
56+
<li><a href="https://api.thetvdb.com/swagger#!/Authentication/get_refresh_token">/refresh_token</a></li>
57+
</ul>
58+
</li>
59+
<li>Episodes
60+
<ul>
61+
<li><a href="https://api.thetvdb.com/swagger#!/Episodes/get_episodes_id">/episodes/{id}</a></li>
62+
</ul>
63+
</li>
64+
<li>Languages
65+
<ul>
66+
<li><a href="https://api.thetvdb.com/swagger#!/Languages/get_languages">/languages</a></li>
67+
<li><a href="https://api.thetvdb.com/swagger#!/Languages/get_languages_id">/languages/{id}</a></li>
68+
</ul>
69+
</li>
70+
<li>Movies
71+
<ul>
72+
<li><a href="https://api.thetvdb.com/swagger#!/Movies/get_movies_id">/movies/{id}</a></li>
73+
<li><a href="https://api.thetvdb.com/swagger#!/Movies/get_movieupdates">/movieupdates</a></li>
74+
</ul>
75+
</li>
76+
<li>Search
77+
<ul>
78+
<li><a href="https://api.thetvdb.com/swagger#!/Search/get_search_series">/search/series</a></li>
79+
<li><a href="https://api.thetvdb.com/swagger#!/Search/get_search_series_params">/search/series/params</a></li>
80+
</ul>
81+
</li>
82+
<li>Series
83+
<ul>
84+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id">/series/{id}</a></li>
85+
<li><a href="https://api.thetvdb.com/swagger#!/Series/head_series_id">/series/{id}</a> (HEAD)</li>
86+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_actors">/series/{id}/actors</a></li>
87+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes">/series/{id}/episodes</a></li>
88+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes_query">/series/{id}/episodes/query</a></li>
89+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes_query_params">/series/{id}/episodes/query/params</a></li>
90+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_episodes_summary">/series/{id}/episodes/summary</a></li>
91+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_filter">/series/{id}/filter</a></li>
92+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_filter_params">/series/{id}/filter/params</a></li>
93+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_images">/series/{id}/images</a></li>
94+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_images_query">/series/{id}/images/query</a></li>
95+
<li><a href="https://api.thetvdb.com/swagger#!/Series/get_series_id_images_query_params">/series/{id}/images/query/params</a></li>
96+
</ul>
97+
</li>
98+
<li>Updates
99+
<ul>
100+
<li><a href="https://api.thetvdb.com/swagger#!/Updates/get_updated_query">/updated/query</a></li>
101+
<li><a href="https://api.thetvdb.com/swagger#!/Updates/get_updated_query_params">/updated/query/params</a></li>
102+
</ul>
103+
</li>
104+
<li>Users
105+
<ul>
106+
<li><a href="https://api.thetvdb.com/swagger#!/Users/get_user">/user</a></li>
107+
<li><a href="https://api.thetvdb.com/swagger#!/Users/get_user_favorites">/user/favorites</a></li>
108+
<li><a href="https://api.thetvdb.com/swagger#!/Users/delete_user_favorites_id">/user/favorites/{id}</a> (DELETE)</li>
109+
<li><a href="https://api.thetvdb.com/swagger#!/Users/put_user_favorites_id">/user/favorites/{id}</a> (PUT)</li>
110+
<li><a href="https://api.thetvdb.com/swagger#!/Users/get_user_ratings">/user/ratings</a></li>
111+
<li><a href="https://api.thetvdb.com/swagger#!/Users/get_user_ratings_query">/user/ratings/query</a></li>
112+
<li><a href="https://api.thetvdb.com/swagger#!/Users/get_user_ratings_query_params">/user/ratings/query/params</a></li>
113+
<li><a href="https://api.thetvdb.com/swagger#!/Users/delete_user_ratings_itemType_itemId">/user/ratings/{itemType}/{itemId}</a></li>
114+
<li><a href="https://api.thetvdb.com/swagger#!/Users/put_user_ratings_itemType_itemId_itemRating">/user/ratings/{itemType}/{itemId}/{itemRating}</a></li>
115+
</ul>
116+
</li>
117+
</ul>
91118
</details>
92119

93120
## Setup
@@ -324,4 +351,4 @@ Ongoing development of a connector compliant to the upcoming _TheTVDB.com_ APIv4
324351
## License
325352
This project is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
326353
>Bear in mind that you might have to negotiate a distinct [license model](https://thetvdb.com/api-information) with
327-
>_TheTVDB.com, LLC._, e.g. when using their API service as part of a commercial product.
354+
>_TheTVDB.com, LLC._, e.g. when using their API service as part of a commercial product.

0 commit comments

Comments
 (0)