Automated update from Spotify Web API reference (#77)

Author: sonallux

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>de.sonallux.spotify</groupId>
     <artifactId>spotify-web-api-parent</artifactId>
-    <version>2021.5.20</version>
+    <version>2021.6.4</version>
     <packaging>pom</packaging>
 
     <name>spotify-web-api-parent</name>

spotify-web-api-core/pom.xml

@@ -7,12 +7,12 @@
     <parent>
         <groupId>de.sonallux.spotify</groupId>
         <artifactId>spotify-web-api-parent</artifactId>
-        <version>2021.5.20</version>
+        <version>2021.6.4</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-core</artifactId>
-    <version>2021.5.20</version>
+    <version>2021.6.4</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-core</name>

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

@@ -1216,7 +1216,8 @@ objects:
       description: The copyright statements of the show.
     - name: description
       type: String
-      description: A description of the show.
+      description: "A description of the show. HTML tags are stripped away from this\
+        \ field, use `html_description` field in case HTML tags are needed."
     - name: episodes
       type: "PagingObject[SimplifiedEpisodeObject]"
       description: A list of the show's episodes.
@@ -1230,6 +1231,9 @@ objects:
     - name: href
       type: String
       description: A link to the Web API endpoint providing full details of the show.
+    - name: html_description
+      type: String
+      description: A description of the show. This field may contain HTML tags.
     - name: id
       type: String
       description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -1509,7 +1513,8 @@ objects:
       description: The copyright statements of the show.
     - name: description
       type: String
-      description: A description of the show.
+      description: "A description of the show. HTML tags are stripped away from this\
+        \ field, use `html_description` field in case HTML tags are needed."
     - name: explicit
       type: Boolean
       description: Whether or not the show has explicit content (true = yes it does;
@@ -1520,6 +1525,9 @@ objects:
     - name: href
       type: String
       description: A link to the Web API endpoint providing full details of the show.
+    - name: html_description
+      type: String
+      description: A description of the show. This field may contain HTML tags.
     - name: id
       type: String
       description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -3125,8 +3133,16 @@ categories:
         parameters:
         - location: HEADER
           name: Authorization
-          description: A valid user access token or your client credentials. Requires
-            the `user-follow-modify` scope.
+          description: "A valid access token from the Spotify Accounts service: see\
+            \ the [Web API Authorization Guide](https://developer.spotify.com/documentation/general/guides/authorization-guide/)\
+            \ for details. The access token must have been issued on behalf of the\
+            \ user.  \nFollowing a playlist publicly requires authorization of the\
+            \ `playlist-modify-public` scope; following a playlist privately requires\
+            \ the `playlist-modify-private` scope. See [Using Scopes](https://developer.spotify.com/documentation/general/guides/authorization-guide/#list-of-scopes).\
+            \  \n*Note that the scopes you provide relate only to whether the current\
+            \ user is following the playlist publicly or privately (i.e. showing others\
+            \ what they are following), not whether the playlist itself is public\
+            \ or private.*"
           type: String
           required: true
         - location: HEADER
@@ -3145,17 +3161,16 @@ categories:
         - location: BODY
           name: public
           description: "Defaults to `true`. If `true` the playlist will be included\
-            \ in user's public playlists, if `false` it will remain private. To be\
-            \ able to follow playlists privately, the user must have granted the `playlist-modify-private`\
-            \ [scope](https://developer.spotify.com/documentation/general/guides/authorization-guide/#list-of-scopes)."
+            \ in user's public playlists, if `false` it will remain private."
           type: Boolean
           required: false
         responseDescription: "On success, the HTTP status code in the response header\
           \ is `200` OK and the response body is empty.\nOn error, the header status\
           \ code is an [error code](https://developer.spotify.com/documentation/web-api/#response-status-codes)\
           \ and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema)."
         scopes:
-        - user-follow-modify
+        - playlist-modify-public
+        - playlist-modify-private
         responseTypes:
         - type: Void
           status: 200

spotify-web-api-generator-open-api/pom.xml

@@ -7,12 +7,12 @@
     <parent>
         <groupId>de.sonallux.spotify</groupId>
         <artifactId>spotify-web-api-parent</artifactId>
-        <version>2021.5.20</version>
+        <version>2021.6.4</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-generator-open-api</artifactId>
-    <version>2021.5.20</version>
+    <version>2021.6.4</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-generator-open-api</name>
@@ -29,7 +29,7 @@
         <dependency>
             <groupId>de.sonallux.spotify</groupId>
             <artifactId>spotify-web-api-core</artifactId>
-            <version>2021.5.20</version>
+            <version>2021.6.4</version>
         </dependency>
         <dependency>
             <groupId>io.swagger.core.v3</groupId>

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

@@ -4,7 +4,7 @@ info:
   contact:
     name: sonallux
     url: https://github.com/sonallux/spotify-web-api
-  version: 2021.5.20
+  version: 2021.6.4
 externalDocs:
   description: Find more info on the official Spotify Web API Reference
   url: https://developer.spotify.com/documentation/web-api/reference
@@ -1854,8 +1854,16 @@ paths:
       parameters:
       - name: Authorization
         in: header
-        description: A valid user access token or your client credentials. Requires
-          the `user-follow-modify` scope.
+        description: "A valid access token from the Spotify Accounts service: see\
+          \ the [Web API Authorization Guide](https://developer.spotify.com/documentation/general/guides/authorization-guide/)\
+          \ for details. The access token must have been issued on behalf of the user.\
+          \  \nFollowing a playlist publicly requires authorization of the `playlist-modify-public`\
+          \ scope; following a playlist privately requires the `playlist-modify-private`\
+          \ scope. See [Using Scopes](https://developer.spotify.com/documentation/general/guides/authorization-guide/#list-of-scopes).\
+          \  \n*Note that the scopes you provide relate only to whether the current\
+          \ user is following the playlist publicly or privately (i.e. showing others\
+          \ what they are following), not whether the playlist itself is public or\
+          \ private.*"
         required: true
         schema:
           type: string
@@ -1884,8 +1892,7 @@ paths:
                   type: boolean
                   description: "Defaults to `true`. If `true` the playlist will be\
                     \ included in user's public playlists, if `false` it will remain\
-                    \ private. To be able to follow playlists privately, the user\
-                    \ must have granted the `playlist-modify-private` [scope](https://developer.spotify.com/documentation/general/guides/authorization-guide/#list-of-scopes)."
+                    \ private."
         required: false
       responses:
         default:
@@ -1897,7 +1904,8 @@ paths:
             \ and the response body contains an [error object](https://developer.spotify.com/documentation/web-api/#response-schema)."
       security:
       - spotify_auth:
-        - user-follow-modify
+        - playlist-modify-public
+        - playlist-modify-private
     delete:
       tags:
       - category-follow
@@ -7353,7 +7361,8 @@ components:
             $ref: '#/components/schemas/CopyrightObject'
         description:
           type: string
-          description: A description of the show.
+          description: "A description of the show. HTML tags are stripped away from\
+            \ this field, use `html_description` field in case HTML tags are needed."
         episodes:
           type: object
           properties:
@@ -7400,6 +7409,9 @@ components:
           type: string
           description: A link to the Web API endpoint providing full details of the
             show.
+        html_description:
+          type: string
+          description: A description of the show. This field may contain HTML tags.
         id:
           type: string
           description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -7698,7 +7710,8 @@ components:
             $ref: '#/components/schemas/CopyrightObject'
         description:
           type: string
-          description: A description of the show.
+          description: "A description of the show. HTML tags are stripped away from\
+            \ this field, use `html_description` field in case HTML tags are needed."
         explicit:
           type: boolean
           description: Whether or not the show has explicit content (true = yes it
@@ -7709,6 +7722,9 @@ components:
           type: string
           description: A link to the Web API endpoint providing full details of the
             show.
+        html_description:
+          type: string
+          description: A description of the show. This field may contain HTML tags.
         id:
           type: string
           description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\

spotify-web-api-parser/pom.xml

@@ -7,12 +7,12 @@
     <parent>
         <groupId>de.sonallux.spotify</groupId>
         <artifactId>spotify-web-api-parent</artifactId>
-        <version>2021.5.20</version>
+        <version>2021.6.4</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-parser</artifactId>
-    <version>2021.5.20</version>
+    <version>2021.6.4</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-parser</name>
@@ -27,7 +27,7 @@
         <dependency>
             <groupId>de.sonallux.spotify</groupId>
             <artifactId>spotify-web-api-core</artifactId>
-            <version>2021.5.20</version>
+            <version>2021.6.4</version>
         </dependency>
         <dependency>
             <groupId>org.jsoup</groupId>