Skip to content

Commit b330eab

Browse files
m0nk3y2k4m0nk3y2k4
committed
Added some more badges and switched back from HTML to markdown for the TheTVDB.com API linked routes overview
1 parent 4697d31 commit b330eab

File tree

2 files changed

+49
-72
lines changed

2 files changed

+49
-72
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88
### Fixed
9-
- Replaced hardcoded Windows line ending in JUnit test with dynamic OS setting
9+
- Replaced hardcoded Windows line ending in JUnit test with dynamic OS setting.
1010

1111
## [3.0.0] - 2020-08-28
1212
First stable release which is fully compatible with _TheTVDB.com_ RESTful remote APIv3.

‎README.md‎

Lines changed: 48 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# thetvdb-java-api
2-
![Java CI with Maven](https://github.com/m0nk3y2k4/thetvdb-java-api/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master&event=push)
3-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2+
![Java CI with Maven](https://github.com/m0nk3y2k4/thetvdb-java-api/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master&event=push)  
3+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)  
4+
[![GitHub release](https://img.shields.io/github/release/m0nk3y2k4/thetvdb-java-api.svg)](https://github.com/m0nk3y2k4/thetvdb-java-api/releases)  
5+
![Java version](https://img.shields.io/badge/Java-10-informational)  
46

57
A simple connector for an easy integration of the [TheTVDB.com](https://thetvdb.com/) RESTful API in Java projects.
68

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

12198
## Setup

0 commit comments

Comments
 (0)