Fix missing description on uris body parameter in endpoint-reorder-or-replace-playlists-tracks

Author: sonallux

spotify-web-api-core/src/main/resources/spotify-web-api.yml

@@ -5299,7 +5299,9 @@ categories:
           required: false
         - location: BODY
           name: uris
-          description: ""
+          description: "A comma-separated list of [Spotify URIs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
+            \ to set, can be track or episode URIs. For example: `uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh,spotify:track:1301WleyT98MSxVHPZCA6M,spotify:episode:512ojhOuo1ktJprKbVcKyQ`\
+            \  \nA maximum of 100 items can be set in one request."
           type: "Array[String]"
           required: false
         - location: BODY

spotify-web-api-generator-open-api/spotify-open-api-spec.yml

@@ -4112,7 +4112,9 @@ paths:
               properties:
                 uris:
                   type: array
-                  description: ""
+                  description: "A comma-separated list of [Spotify URIs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
+                    \ to set, can be track or episode URIs. For example: `uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh,spotify:track:1301WleyT98MSxVHPZCA6M,spotify:episode:512ojhOuo1ktJprKbVcKyQ`\
+                    \  \nA maximum of 100 items can be set in one request."
                   items:
                     type: string
                 range_start:

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

@@ -121,7 +121,7 @@ public ReorderPlaylistsTracksRequest reorderPlaylistsTracks(String playlistId, i
      * <h3>Replace items in a playlist</h3>
      * <p>Replace all the items in a playlist, overwriting its existing items. This powerful request can be useful for replacing items, re-ordering existing items, or clearing the playlist.</p>
      * @param playlistId <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a> for the playlist.</p>
-     * @param uris 
+     * @param uris <p>A comma-separated list of <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify URIs</a> to set, can be track or episode URIs. For example: <code>uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh,spotify:track:1301WleyT98MSxVHPZCA6M,spotify:episode:512ojhOuo1ktJprKbVcKyQ</code><br>A maximum of 100 items can be set in one request.</p>
      * @return a {@link ReplacePlaylistsTracksRequest} object to build and execute the request
      */
     public ReplacePlaylistsTracksRequest replacePlaylistsTracks(String playlistId, java.util.List<String> uris) {

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

@@ -25,7 +25,7 @@ public class ReplacePlaylistsTracksRequest {
      * <h3>Replace items in a playlist request</h3>
      * @param apiClient <p>The API client</p>
      * @param playlistId <p>The <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify ID</a> for the playlist.</p>
-     * @param uris 
+     * @param uris <p>A comma-separated list of <a href="https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids">Spotify URIs</a> to set, can be track or episode URIs. For example: <code>uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh,spotify:track:1301WleyT98MSxVHPZCA6M,spotify:episode:512ojhOuo1ktJprKbVcKyQ</code><br>A maximum of 100 items can be set in one request.</p>
      */
     public ReplacePlaylistsTracksRequest(ApiClient apiClient, String playlistId, java.util.List<String> uris) {
         this.apiClient = apiClient;

spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/ApiEndpointFixes.java

@@ -6,7 +6,7 @@
 import java.util.List;
 import java.util.SortedMap;
 
-import static de.sonallux.spotify.core.model.SpotifyWebApiEndpoint.ParameterLocation.PATH;
+import static de.sonallux.spotify.core.model.SpotifyWebApiEndpoint.ParameterLocation.*;
 
 @Slf4j
 class ApiEndpointFixes {
@@ -17,6 +17,7 @@ static void fixApiEndpoints(SortedMap<String, SpotifyWebApiCategory> categories)
         fixStartAUsersPlayback(categories);
         fixGetUsersSavedShowsScope(categories);
         fixCheckUsersSavedShowsScope(categories);
+        fixReplaceAndReorderPlaylistTrackUrisParameter(categories);
     }
 
     private static void fixChangePlaylistsDetails(SortedMap<String, SpotifyWebApiCategory> categories) {
@@ -113,4 +114,29 @@ private static void fixCheckUsersSavedShowsScope(SortedMap<String, SpotifyWebApi
             endpoint.setScopes(List.of("user-library-read"));
         }
     }
+
+    private static void fixReplaceAndReorderPlaylistTrackUrisParameter(SortedMap<String, SpotifyWebApiCategory> categories) {
+        var endpoint = categories.get("category-playlists")
+            .getEndpoints().get("endpoint-reorder-or-replace-playlists-tracks");
+
+        var urisBodyParameter = endpoint.getParameters().stream()
+            .filter(p -> p.getLocation() == BODY && "uris".equals(p.getName()))
+            .findFirst().orElse(null);
+        if (urisBodyParameter == null) {
+            log.warn("Can not find uris body parameter in endpoint-reorder-or-replace-playlists-tracks");
+            return;
+        } else if (!urisBodyParameter.getDescription().isBlank()) {
+            log.warn("Missing description on uris body parameter in endpoint-reorder-or-replace-playlists-tracks has been fixed");
+        }
+
+        var urisQueryParameter = endpoint.getParameters().stream()
+            .filter(p -> p.getLocation() == QUERY && "uris".equals(p.getName()))
+            .findFirst().orElse(null);
+        if (urisQueryParameter == null) {
+            log.warn("Can not find uris query parameter in endpoint-reorder-or-replace-playlists-tracks");
+            return;
+        }
+
+        urisBodyParameter.setDescription(urisQueryParameter.getDescription());
+    }
 }