Set additional_types parameter by default

Author: sonallux

spotify-web-api-generator-java/src/main/java/de/sonallux/spotify/generator/java/templates/ApiTemplate.java

@@ -19,7 +19,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import static java.nio.file.StandardOpenOption.*;
@@ -160,6 +159,13 @@ private List<Parameter> generateEndpointRequest(SpotifyWebApiEndpoint endpoint,
 
         context.put("requiredJavaDocParameters", requiredParameterList.stream().map(Parameter::asJavaDoc).collect(toList()));
 
+        optionalQueryParameters.stream()
+            .filter(p -> "additional_types".equals(p.getName()))
+            .findFirst().ifPresent(additionalTypesParameter -> {
+                additionalTypesParameter.setDefaultValue("\"track,episode\"");
+                context.put("parametersWithDefaultValue", List.of(additionalTypesParameter));
+        });
+
         var packageFolder = getPackageFolder(outputFolder, javaPackage);
         var outputFile = packageFolder.resolve(JavaUtils.getFileName(JavaUtils.getEndpointRequestBuilderName(endpoint)));
         generateFile(outputFile, requestTemplate, context);
@@ -193,16 +199,18 @@ private String getResponseType(SpotifyWebApiEndpoint endpoint) {
     @Getter
     @Setter
     private static class Parameter {
+        private String name;
         private String javaName;
-        private String jsonName;
         private String type;
         private String description;
+        private String defaultValue;
 
-        public Parameter(String jsonName, String type, String description) {
-            this.javaName = JavaUtils.escapeFieldName(jsonName);
-            this.jsonName = jsonName;
+        public Parameter(String name, String type, String description) {
+            this.name = name;
+            this.javaName = JavaUtils.escapeFieldName(name);
             this.type = JavaUtils.mapToPrimitiveJavaType(type);
             this.description = Markdown2Html.convertToSingleLine(description);
+            this.defaultValue = null;
         }
 
         public String asMethodParameter() {

spotify-web-api-generator-java/src/main/resources/templates/request.mustache

@@ -41,23 +41,26 @@ public class {{className}} {
         this.apiClient = apiClient;
         this.request = new Request("{{httpMethod}}", "{{path}}")
 {{#requiredPathParameters}}
-            .addPathParameter("{{jsonName}}", String.valueOf({{javaName}}))
+            .addPathParameter("{{name}}", String.valueOf({{javaName}}))
 {{/requiredPathParameters}}
 {{#requiredQueryParameters}}
-            .addQueryParameter("{{jsonName}}", String.valueOf({{javaName}}))
+            .addQueryParameter("{{name}}", String.valueOf({{javaName}}))
 {{/requiredQueryParameters}}
 {{#requiredBodyParameters}}
-            .addBodyParameter("{{jsonName}}", {{javaName}})
+            .addBodyParameter("{{name}}", {{javaName}})
 {{/requiredBodyParameters}}
         ;
+{{#parametersWithDefaultValue}}
+        this.{{javaName}}({{defaultValue}});
+{{/parametersWithDefaultValue}}
     }
 
 {{#optionalPathParameters}}
     /**
      * {{description}}
      */
     public {{className}} {{javaName}}({{type}} {{javaName}}) {
-        this.request.addPathParameter("{{jsonName}}", String.valueOf({{javaName}}));
+        this.request.addPathParameter("{{name}}", String.valueOf({{javaName}}));
         return this;
     }
 
@@ -67,7 +70,7 @@ public class {{className}} {
      * {{description}}
      */
     public {{className}} {{javaName}}({{type}} {{javaName}}) {
-        this.request.addQueryParameter("{{jsonName}}", String.valueOf({{javaName}}));
+        this.request.addQueryParameter("{{name}}", String.valueOf({{javaName}}));
         return this;
     }
 
@@ -77,7 +80,7 @@ public class {{className}} {
      * {{description}}
      */
     public {{className}} {{javaName}}({{type}} {{javaName}}) {
-        this.request.addBodyParameter("{{jsonName}}", {{javaName}});
+        this.request.addBodyParameter("{{name}}", {{javaName}});
         return this;
     }
 

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/player/GetInformationAboutUsersCurrentPlaybackRequest.java

@@ -29,6 +29,7 @@ public GetInformationAboutUsersCurrentPlaybackRequest(ApiClient apiClient) {
         this.apiClient = apiClient;
         this.request = new Request("GET", "/me/player")
         ;
+        this.additionalTypes("track,episode");
     }
 
     /**

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/player/GetUsersCurrentlyPlayingTrackRequest.java

@@ -33,6 +33,7 @@ public GetUsersCurrentlyPlayingTrackRequest(ApiClient apiClient, String market)
         this.request = new Request("GET", "/me/player/currently-playing")
             .addQueryParameter("market", String.valueOf(market))
         ;
+        this.additionalTypes("track,episode");
     }
 
     /**

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/playlists/GetPlaylistRequest.java

@@ -27,6 +27,7 @@ public GetPlaylistRequest(ApiClient apiClient, String playlistId) {
         this.request = new Request("GET", "/playlists/{playlist_id}")
             .addPathParameter("playlist_id", String.valueOf(playlistId))
         ;
+        this.additionalTypes("track,episode");
     }
 
     /**

spotify-web-api-java/src/main/generated/de/sonallux/spotify/api/apis/playlists/GetPlaylistsTracksRequest.java

@@ -29,6 +29,7 @@ public GetPlaylistsTracksRequest(ApiClient apiClient, String playlistId, String
             .addPathParameter("playlist_id", String.valueOf(playlistId))
             .addQueryParameter("market", String.valueOf(market))
         ;
+        this.additionalTypes("track,episode");
     }
 
     /**

spotify-web-api-java/src/test/java/de/sonallux/spotify/api/ConversionTest.java

@@ -107,10 +107,10 @@ void testUnionTypeHandlingWithAdditionalTypesParameter() throws Exception {
         assertNotNull(episode);
         assertEquals("episode", episode.getType());
         assertTrue(episode instanceof Episode);
+        assertNotNull(((Episode) episode).getShow());
 
         var request = webServer.takeRequest();
-        // TODO: adjust when additional_types is set by default
-        assertEquals("/playlists/foo/tracks?market=DE", request.getPath());
+        assertEquals("/playlists/foo/tracks?market=DE&additional_types=track%2Cepisode", request.getPath());
     }
 
     @Test
@@ -129,6 +129,7 @@ void testUnionTypeHandlingWithoutAdditionalTypesParameter() throws Exception {
         assertNotNull(episode);
         assertEquals("episode", episode.getType());
         assertTrue(episode instanceof Episode);
+        assertNull(((Episode) episode).getShow());//show is not set, because episode is returned with track format
 
         var request = webServer.takeRequest();
         assertEquals("/playlists/foo/tracks?market=DE&additional_types=track", request.getPath());