Spotify Web API reference update (#92)

* Automated update from Spotify Web API reference

* Update fixes

* Add fix for Authorization header in available markets endpoint

Author: sonallux

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>de.sonallux.spotify</groupId>
     <artifactId>spotify-web-api-parent</artifactId>
-    <version>2021.7.20</version>
+    <version>2021.8.15</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.7.20</version>
+        <version>2021.8.15</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-core</artifactId>
-    <version>2021.7.20</version>
+    <version>2021.8.15</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-core</name>

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

@@ -8,7 +8,7 @@ objects:
     properties:
     - name: album_type
       type: String
-      description: "The type of the album: `album`, `single`, or `compilation`."
+      description: The type of the album.
     - name: artists
       type: "Array[ArtistObject]"
       description: The artists of the album. Each artist object includes a link in
@@ -17,7 +17,7 @@ objects:
       type: "Array[String]"
       description: "The markets in which the album is available: [ISO 3166-1 alpha-2\
         \ country codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Note that\
-        \ an album is considered available in a market when at least 1 of its tracks\
+        \ an album is considered available in a market when at least one of its tracks\
         \ is available in that market."
     - name: copyrights
       type: "Array[CopyrightObject]"
@@ -30,8 +30,8 @@ objects:
       description: Known external URLs for this album.
     - name: genres
       type: "Array[String]"
-      description: "A list of the genres used to classify the album. For example:\
-        \ \"Prog Rock\" , \"Post-Grunge\". (If not yet classified, the array is empty.)"
+      description: "A list of the genres used to classify the album. (If not yet classified,\
+        \ the array is empty.)"
     - name: href
       type: String
       description: A link to the Web API endpoint providing full details of the album.
@@ -50,18 +50,16 @@ objects:
         \ may be an empty string."
     - name: popularity
       type: Integer
-      description: "The popularity of the album. The value will be between 0 and 100,\
-        \ with 100 being the most popular. The popularity is calculated from the popularity\
-        \ of the album's individual tracks."
+      description: "The popularity of the album, with 100 being the most popular.\
+        \ The popularity is calculated from the popularity of the album's individual\
+        \ tracks."
     - name: release_date
       type: String
-      description: "The date the album was first released, for example \"1981-12-15\"\
-        . Depending on the precision, it might be shown as \"1981\" or \"1981-12\"\
-        ."
+      description: "The date the album was first released. Depending on the precision,\
+        \ it might be shown as \"1981\" or \"1981-12\"."
     - name: release_date_precision
       type: String
-      description: "The precision with which release_date value is known: \"year\"\
-        \ , \"month\" , or \"day\"."
+      description: The precision with which release_date value is known.
     - name: restrictions
       type: AlbumRestrictionObject
       description: "Included in the response when a content restriction is applied.\
@@ -75,7 +73,7 @@ objects:
       description: The tracks of the album.
     - name: type
       type: String
-      description: "The object type: \"album\""
+      description: The object type.
     - name: uri
       type: String
       description: The Spotify URI for the album.
@@ -86,13 +84,10 @@ objects:
     properties:
     - name: reason
       type: String
-      description: "The reason for the restriction. Supported values:  \n\n- `market`\
-        \ - The content item is not available in the given market.  \n- `product`\
-        \ - The content item is not available for the user's subscription type.  \n\
-        - `explicit` - The content item is explicit and the user's account is set\
-        \ to not play explicit content.  \n  Additional reasons may be added in the\
-        \ future. **Note**: If you use this field, make sure that your application\
-        \ safely handles unknown values."
+      description: "The reason for the restriction. Albums may be restricted if the\
+        \ content is not available in a given market, to the user's subscription type,\
+        \ or when the user's account is set to not play explicit content. Additional\
+        \ reasons may be added in the future."
   AlbumsObject:
     name: AlbumsObject
     properties:
@@ -112,9 +107,8 @@ objects:
       description: Information about the followers of the artist.
     - name: genres
       type: "Array[String]"
-      description: "A list of the genres the artist is associated with. For example:\
-        \ `\"Prog Rock\"` , `\"Post-Grunge\"`. (If not yet classified, the array is\
-        \ empty.)"
+      description: "A list of the genres the artist is associated with. If not yet\
+        \ classified, the array is empty."
     - name: href
       type: String
       description: A link to the Web API endpoint providing full details of the artist.
@@ -135,7 +129,7 @@ objects:
         \ from the popularity of all the artist's tracks."
     - name: type
       type: String
-      description: "The object type: `\"artist\"`"
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -432,7 +426,7 @@ objects:
     properties:
     - name: id
       type: String
-      description: The device ID. This may be `null`.
+      description: The device ID.
     - name: is_active
       type: Boolean
       description: If this device is the currently active device.
@@ -452,7 +446,7 @@ objects:
         ."
     - name: volume_percent
       type: Integer
-      description: The current volume in percent. This may be null.
+      description: The current volume in percent.
   DevicesObject:
     name: DevicesObject
     id: object-devicesobject
@@ -558,8 +552,7 @@ objects:
         `."
     - name: release_date_precision
       type: String
-      description: "The precision with which `release_date` value is known: `\"year\"\
-        `, `\"month\"`, or `\"day\"`."
+      description: The precision with which `release_date` value is known.
     - name: restrictions
       type: EpisodeRestrictionObject
       description: "Included in the response when a content restriction is applied.\
@@ -574,7 +567,7 @@ objects:
       description: The show on which the episode belongs.
     - name: type
       type: String
-      description: "The object type: \"episode\"."
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -694,13 +687,13 @@ objects:
     properties:
     - name: height
       type: Integer
-      description: "The image height in pixels. If unknown: `null` or not returned."
+      description: The image height in pixels.
     - name: url
       type: String
       description: The source URL of the image.
     - name: width
       type: Integer
-      description: "The image width in pixels. If unknown: `null` or not returned."
+      description: The image width in pixels.
   LinkedTrackObject:
     name: LinkedTrackObject
     id: object-linkedtrackobject
@@ -989,7 +982,7 @@ objects:
       description: The user's profile image.
     - name: type
       type: String
-      description: "The object type: \"user\""
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -1258,7 +1251,7 @@ objects:
       description: The publisher of the show.
     - name: type
       type: String
-      description: "The object type: \"show\"."
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -1276,14 +1269,11 @@ objects:
     properties:
     - name: album_group
       type: String
-      description: "The field is present when getting an artist's albums. Possible\
-        \ values are \"album\", \"single\", \"compilation\", \"appears_on\". Compare\
-        \ to album_type this field represents relationship between the artist and\
-        \ the album."
+      description: The field is present when getting an artist's albums. Compare to
+        album_type this field represents relationship between the artist and the album.
     - name: album_type
       type: String
-      description: "The type of the album: one of \"album\", \"single\", or \"compilation\"\
-        ."
+      description: The type of the album.
     - name: artists
       type: "Array[SimplifiedArtistObject]"
       description: The artists of the album. Each artist object includes a link in
@@ -1313,23 +1303,19 @@ objects:
         \ may be an empty string."
     - name: release_date
       type: String
-      description: "The date the album was first released, for example `1981`. Depending\
-        \ on the precision, it might be shown as `1981-12` or `1981-12-15`."
+      description: The date the album was first released.
     - name: release_date_precision
       type: String
-      description: "The precision with which `release_date` value is known: `year`\
-        \ , `month` , or `day`."
+      description: The precision with which `release_date` value is known.
     - name: restrictions
       type: AlbumRestrictionObject
-      description: "Included in the response when a content restriction is applied.\
-        \ See [Restriction Object](https://developer.spotify.com/documentation/web-api/reference/#object-albumrestrictionobject)\
-        \ for more details."
+      description: Included in the response when a content restriction is applied.
     - name: total_tracks
       type: Integer
-      description: The total number of tracks in the album.
+      description: The number of tracks in the album.
     - name: type
       type: String
-      description: "The object type: \"album\""
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -1354,7 +1340,7 @@ objects:
       description: The name of the artist.
     - name: type
       type: String
-      description: "The object type: `\"artist\"`"
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -1421,8 +1407,7 @@ objects:
         `."
     - name: release_date_precision
       type: String
-      description: "The precision with which `release_date` value is known: `\"year\"\
-        `, `\"month\"`, or `\"day\"`."
+      description: The precision with which `release_date` value is known.
     - name: restrictions
       type: EpisodeRestrictionObject
       description: "Included in the response when a content restriction is applied.\
@@ -1434,7 +1419,7 @@ objects:
         access token is a user token and has the scope 'user-read-playback-position'.
     - name: type
       type: String
-      description: "The object type: \"episode\"."
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -1552,7 +1537,7 @@ objects:
       description: The publisher of the show.
     - name: type
       type: String
-      description: "The object type: \"show\"."
+      description: The object type.
     - name: uri
       type: String
       description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\
@@ -3059,15 +3044,14 @@ categories:
           required: false
         - location: QUERY
           name: type
-          description: "The ID type: either `artist` or `user`."
+          description: The ID type.
           type: String
           required: true
         - location: QUERY
           name: ids
           description: "A comma-separated list of the artist or the user [Spotify\
             \ IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids).\
-            \ For example: `ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q`. A\
-            \ maximum of 50 IDs can be sent in one request."
+            \ A maximum of 50 IDs can be sent in one request."
           type: String
           required: true
         - location: BODY
@@ -3348,7 +3332,7 @@ categories:
           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 isued on behalf of the\
-            \ user. The `user-libary-read` scope must have been authorised by the\
+            \ user. The `user-library-read` scope must have been authorised by the\
             \ user."
           type: String
           required: true
@@ -3512,7 +3496,7 @@ categories:
           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 isued on behalf of the\
-            \ user. The `user-libary-read` scope must have been authorised by the\
+            \ user. The `user-library-read` scope must have been authorised by the\
             \ user."
           type: String
           required: true

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.7.20</version>
+        <version>2021.8.15</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-generator-open-api</artifactId>
-    <version>2021.7.20</version>
+    <version>2021.8.15</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-generator-open-api</name>
@@ -31,7 +31,7 @@
         <dependency>
             <groupId>de.sonallux.spotify</groupId>
             <artifactId>spotify-web-api-core</artifactId>
-            <version>2021.7.20</version>
+            <version>2021.8.15</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>