Add variants of comments that accept Cache-Control header

CHANGELOG.md

@@ -1,5 +1,11 @@
 Change Log
 ==========
+               
+## Next version
+_in development
+
+* Add variants of the comments methods that accept a `Cache-Control` header.
+  This can be used to skip the local cache and get the latest comments from the server.
 
 ## 6.12.0
 _2024-01-25_

src/main/java/com/uwetrottmann/trakt5/services/Episodes.java

@@ -7,6 +7,7 @@
 import com.uwetrottmann.trakt5.enums.Extended;
 import retrofit2.Call;
 import retrofit2.http.GET;
+import retrofit2.http.Header;
 import retrofit2.http.Path;
 import retrofit2.http.Query;
 
@@ -46,6 +47,20 @@ Call<List<Comment>> comments(
             @Query(value = "extended", encoded = true) Extended extended
     );
 
+    /**
+     * Variant that allows changing the Cache-Control header.
+     */
+    @GET("shows/{id}/seasons/{season}/episodes/{episode}/comments")
+    Call<List<Comment>> comments(
+            @Path("id") String showId,
+            @Path("season") int season,
+            @Path("episode") int episode,
+            @Query("page") Integer page,
+            @Query("limit") Integer limit,
+            @Query(value = "extended", encoded = true) Extended extended,
+            @Header("Cache-Control") String cacheControl
+    );
+
     /**
      * Returns rating (between 0 and 10) and distribution for an episode.
      *

src/main/java/com/uwetrottmann/trakt5/services/Movies.java

@@ -10,6 +10,7 @@
 import com.uwetrottmann.trakt5.enums.Extended;
 import retrofit2.Call;
 import retrofit2.http.GET;
+import retrofit2.http.Header;
 import retrofit2.http.Path;
 import retrofit2.http.Query;
 
@@ -91,6 +92,18 @@ Call<List<Comment>> comments(
             @Query(value = "extended", encoded = true) Extended extended
     );
 
+    /**
+     * Variant that allows changing the Cache-Control header.
+     */
+    @GET("movies/{id}/comments")
+    Call<List<Comment>> comments(
+            @Path("id") String movieId,
+            @Query("page") Integer page,
+            @Query("limit") Integer limit,
+            @Query(value = "extended", encoded = true) Extended extended,
+            @Header("Cache-Control") String cacheControl
+    );
+
     /**
      * Returns all actors, directors, writers, and producers for a movie.
      *

src/main/java/com/uwetrottmann/trakt5/services/Seasons.java

@@ -8,6 +8,7 @@
 import com.uwetrottmann.trakt5.enums.Extended;
 import retrofit2.Call;
 import retrofit2.http.GET;
+import retrofit2.http.Header;
 import retrofit2.http.Path;
 import retrofit2.http.Query;
 
@@ -51,6 +52,16 @@ Call<List<Comment>> comments(
             @Path("season") int season
     );
 
+    /**
+     * Variant that allows changing the Cache-Control header.
+     */
+    @GET("shows/{id}/seasons/{season}/comments")
+    Call<List<Comment>> comments(
+            @Path("id") String showId,
+            @Path("season") int season,
+            @Header("Cache-Control") String cacheControl
+    );
+
     /**
      * Returns rating (between 0 and 10) and distribution for a season.
      *

src/main/java/com/uwetrottmann/trakt5/services/Shows.java

@@ -12,6 +12,7 @@
 import com.uwetrottmann.trakt5.enums.ProgressLastActivity;
 import retrofit2.Call;
 import retrofit2.http.GET;
+import retrofit2.http.Header;
 import retrofit2.http.Path;
 import retrofit2.http.Query;
 
@@ -93,6 +94,18 @@ Call<List<Comment>> comments(
             @Query(value = "extended", encoded = true) Extended extended
     );
 
+    /**
+     * Variant that allows changing the Cache-Control header.
+     */
+    @GET("shows/{id}/comments")
+    Call<List<Comment>> comments(
+            @Path("id") String showId,
+            @Query("page") Integer page,
+            @Query("limit") Integer limit,
+            @Query(value = "extended", encoded = true) Extended extended,
+            @Header("Cache-Control") String cacheControl
+    );
+
     /**
      * <b>OAuth Required</b>
      *