Fix limit parameter

- minimum value of limit parameter is one and not zero
- get playlists tracks endpoint has a maximum limit of 100 and not 50
- use already existing QueryLimit parameter where possible

Author: sonallux

fixed-spotify-open-api.yml

@@ -538,7 +538,7 @@ paths:
           default: 20
           example: 10
           type: integer
-          minimum: 0
+          minimum: 1
           maximum: 50
       - name: offset
         required: false
@@ -735,9 +735,20 @@ paths:
             can be excluded by prefixing them with an exclamation mark, for example:<br>`fields=items.track.album(!external_urls,images)`
           example: "items(added_by.id,track(name,href,album(name,href)))"
           type: string
-      - $ref: '#/components/parameters/QueryLimit'
       - $ref: '#/components/parameters/QueryOffset'
       - $ref: '#/components/parameters/QueryAdditionalTypes'
+      - name: limit
+        required: false
+        in: query
+        schema:
+          title: Limit
+          description: |
+            The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100.
+          default: 20
+          example: 10
+          type: integer
+          minimum: 1
+          maximum: 100
       responses:
         "200":
           $ref: '#/components/responses/PlaylistTracksPagingObject'
@@ -2063,18 +2074,7 @@ paths:
             The last artist ID retrieved from the previous request.
           example: 0I2XqVXqHScXjHhk6AYYRe
           type: string
-      - name: limit
-        required: false
-        in: query
-        schema:
-          title: Limit
-          description: |
-            The maximum number of items to return. Default: 20\. Minimum: 1\. Maximum: 50\.
-          default: 20
-          example: 10
-          type: integer
-          minimum: 0
-          maximum: 50
+      - $ref: '#/components/parameters/QueryLimit'
       responses:
         "200":
           $ref: '#/components/responses/CursorPagedArtists'
@@ -3390,18 +3390,6 @@ paths:
         Get tracks from the current user's recently played tracks.
         _**Note**: Currently doesn't support podcast episodes._
       parameters:
-      - name: limit
-        required: false
-        in: query
-        schema:
-          title: Limit
-          description: |
-            The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
-          default: 20
-          example: 10
-          type: integer
-          minimum: 0
-          maximum: 50
       - name: after
         required: false
         in: query
@@ -3423,6 +3411,7 @@ paths:
             before (but not including) this cursor position. If `before` is specified,
             `after` must not be specified.
           type: integer
+      - $ref: '#/components/parameters/QueryLimit'
       responses:
         "200":
           $ref: '#/components/responses/PlayHistoryCursorPagingObject'
@@ -6448,7 +6437,7 @@ components:
         default: 20
         example: 10
         type: integer
-        minimum: 0
+        minimum: 1
         maximum: 50
     QueryOffset:
       name: offset

spotify-web-api-open-api/src/main/resources/patches/parameter-QueryLimit.yml

@@ -0,0 +1,8 @@
+description: Minimum value for limit parameter is one not zero
+operations:
+  - op: test
+    path: "$.components.parameters.QueryLimit.schema.minimum"
+    value: 0
+  - op: set
+    path: "$.components.parameters.QueryLimit.schema.minimum"
+    value: 1

spotify-web-api-open-api/src/main/resources/patches/path-get-followed.yml

@@ -0,0 +1,23 @@
+description: Use existing QueryLimit parameter
+operations:
+  - op: test
+    path: "$.paths./me/following.get.parameters[?(@.name=='limit')]"
+    value:
+      - name: limit
+        required: false
+        in: query
+        schema:
+          title: Limit
+          description: |
+            The maximum number of items to return. Default: 20\. Minimum: 1\. Maximum: 50\.
+          default: 20
+          example: 10
+          type: integer
+          minimum: 0
+          maximum: 50
+  - op: delete
+    path: "$.paths./me/following.get.parameters[?(@.name=='limit')]"
+  - op: add
+    path: "$.paths./me/following.get.parameters"
+    value:
+      $ref: '#/components/parameters/QueryLimit'

spotify-web-api-open-api/src/main/resources/patches/path-get-playlists-tracks.yml

@@ -1,8 +1,29 @@
-description: update response type to PlaylistTracksPagingObject
+description: update response type to PlaylistTracksPagingObject and fix maximum of limit parameter
 operations:
   - op: test
     path: "$.paths./playlists/{playlist_id}/tracks.get.responses.200.$ref"
     value: '#/components/responses/PagingObject'
   - op: set
     path: "$.paths./playlists/{playlist_id}/tracks.get.responses.200.$ref"
     value: '#/components/responses/PlaylistTracksPagingObject'
+  - op: test
+    path: "$.paths./playlists/{playlist_id}/tracks.get.parameters[?(@.$ref=='#/components/parameters/QueryLimit')]"
+    value:
+      - $ref: '#/components/parameters/QueryLimit'
+  - op: delete
+    path: "$.paths./playlists/{playlist_id}/tracks.get.parameters[?(@.$ref=='#/components/parameters/QueryLimit')]"
+  - op: add
+    path: "$.paths./playlists/{playlist_id}/tracks.get.parameters"
+    value:
+      name: limit
+      required: false
+      in: query
+      schema:
+        title: Limit
+        description: |
+          The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100.
+        default: 20
+        example: 10
+        type: integer
+        minimum: 1
+        maximum: 100

spotify-web-api-open-api/src/main/resources/patches/path-get-recently-played.yml

@@ -1,8 +1,29 @@
-description: update response type to PlayHistoryCursorPagingObject
+description: update response type to PlayHistoryCursorPagingObject and use existing QueryLimit parameter
 operations:
   - op: test
     path: "$.paths./me/player/recently-played.get.responses.200.$ref"
     value: '#/components/responses/CursorPaging'
   - op: set
     path: "$.paths./me/player/recently-played.get.responses.200.$ref"
     value: '#/components/responses/PlayHistoryCursorPagingObject'
+  - op: test
+    path: "$.paths./me/player/recently-played.get.parameters[?(@.name=='limit')]"
+    value:
+      - name: limit
+        required: false
+        in: query
+        schema:
+          title: Limit
+          description: |
+            The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+          default: 20
+          example: 10
+          type: integer
+          minimum: 0
+          maximum: 50
+  - op: delete
+    path: "$.paths./me/player/recently-played.get.parameters[?(@.name=='limit')]"
+  - op: add
+    path: "$.paths./me/player/recently-played.get.parameters"
+    value:
+      $ref: '#/components/parameters/QueryLimit'

spotify-web-api-open-api/src/main/resources/patches/path-search.yml

@@ -1,4 +1,4 @@
-description: Fix parameter type
+description: Fix schema of type parameter and fix minimum value of limit parameter
 operations:
   - op: test
     path: "$.paths./search.get.parameters[?(@.name=='type')].schema.items"
@@ -26,3 +26,9 @@ operations:
         - episode
   - op: delete
     path: "$.paths./search.get.parameters[?(@.name=='type')].schema.enum"
+  - op: test
+    path: "$.paths./search.get.parameters[?(@.name=='limit')].schema.minimum"
+    value: [0]
+  - op: set
+    path: "$.paths./search.get.parameters[?(@.name=='limit')].schema.minimum"
+    value: 1