From e6cda56c9463c50cdd47ede04c4f5788ea9d3835 Mon Sep 17 00:00:00 2001 From: sonallux <13821543+sonallux@users.noreply.github.com> Date: Sat, 17 Apr 2021 02:22:44 +0000 Subject: [PATCH] Automated Spotify Web API update --- .../src/main/resources/spotify-web-api.yml | 36 +++++++++++++++++-- .../spotify-web-api-openapi.yml | 33 +++++++++++++++-- 2 files changed, 65 insertions(+), 4 deletions(-) diff --git a/spotify-web-api-core/src/main/resources/spotify-web-api.yml b/spotify-web-api-core/src/main/resources/spotify-web-api.yml index 02afa2d1..fc86ae45 100644 --- a/spotify-web-api-core/src/main/resources/spotify-web-api.yml +++ b/spotify-web-api-core/src/main/resources/spotify-web-api.yml @@ -504,7 +504,8 @@ objects: if not available. - name: description type: String - description: A description of the episode. + description: "A description of the episode. HTML tags are stripped away from\ + \ this field, use `html_description` field in case HTML tags are needed." - name: duration_ms type: Integer description: The episode length in milliseconds. @@ -518,6 +519,9 @@ objects: - name: href type: String description: A link to the Web API endpoint providing full details of the episode. + - name: html_description + type: String + description: A description of the episode. 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)\ @@ -553,6 +557,11 @@ objects: type: String description: "The precision with which `release_date` value is known: `\"year\"\ `, `\"month\"`, or `\"day\"`." + - name: restrictions + type: EpisodeRestrictionObject + description: "Included in the response when a content restriction is applied.\ + \ See [Restriction Object](https://developer.spotify.com/documentation/web-api/reference/#object-episoderestrictionobject)\ + \ for more details." - name: resume_point type: ResumePointObject description: The user's most recent position in the episode. Set if the supplied @@ -567,6 +576,20 @@ objects: type: String description: "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\ \ for the episode." + EpisodeRestrictionObject: + name: EpisodeRestrictionObject + id: object-episoderestrictionobject + link: https://developer.spotify.com/documentation/web-api/reference/#object-episoderestrictionobject + 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." EpisodesObject: name: EpisodesObject properties: @@ -1339,7 +1362,8 @@ objects: if not available. - name: description type: String - description: A description of the episode. + description: "A description of the episode. HTML tags are stripped away from\ + \ this field, use `html_description` field in case HTML tags are needed." - name: duration_ms type: Integer description: The episode length in milliseconds. @@ -1353,6 +1377,9 @@ objects: - name: href type: String description: A link to the Web API endpoint providing full details of the episode. + - name: html_description + type: String + description: A description of the episode. 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)\ @@ -1388,6 +1415,11 @@ objects: type: String description: "The precision with which `release_date` value is known: `\"year\"\ `, `\"month\"`, or `\"day\"`." + - name: restrictions + type: EpisodeRestrictionObject + description: "Included in the response when a content restriction is applied.\ + \ See [Restriction Object](https://developer.spotify.com/documentation/web-api/reference/#object-episoderestrictionobject)\ + \ for more details." - name: resume_point type: ResumePointObject description: The user's most recent position in the episode. Set if the supplied diff --git a/spotify-web-api-generator-open-api/spotify-web-api-openapi.yml b/spotify-web-api-generator-open-api/spotify-web-api-openapi.yml index a391ebf9..b0a7d338 100644 --- a/spotify-web-api-generator-open-api/spotify-web-api-openapi.yml +++ b/spotify-web-api-generator-open-api/spotify-web-api-openapi.yml @@ -6186,7 +6186,9 @@ components: if not available. description: type: string - description: A description of the episode. + description: "A description of the episode. HTML tags are stripped away\ + \ from this field, use `html_description` field in case HTML tags are\ + \ needed." duration_ms: type: integer description: The episode length in milliseconds. @@ -6201,6 +6203,9 @@ components: type: string description: A link to the Web API endpoint providing full details of the episode. + html_description: + type: string + description: A description of the episode. This field may contain HTML tags. id: type: string description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\ @@ -6241,6 +6246,8 @@ components: type: string description: "The precision with which `release_date` value is known: `\"\ year\"`, `\"month\"`, or `\"day\"`." + restrictions: + $ref: '#/components/schemas/EpisodeRestrictionObject' resume_point: $ref: '#/components/schemas/ResumePointObject' show: @@ -6255,6 +6262,21 @@ components: externalDocs: description: Find more info on the official Spotify Web API Reference url: https://developer.spotify.com/documentation/web-api/reference/#object-episodeobject + EpisodeRestrictionObject: + type: object + properties: + 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." + externalDocs: + description: Find more info on the official Spotify Web API Reference + url: https://developer.spotify.com/documentation/web-api/reference/#object-episoderestrictionobject EpisodesObject: type: object properties: @@ -7491,7 +7513,9 @@ components: if not available. description: type: string - description: A description of the episode. + description: "A description of the episode. HTML tags are stripped away\ + \ from this field, use `html_description` field in case HTML tags are\ + \ needed." duration_ms: type: integer description: The episode length in milliseconds. @@ -7506,6 +7530,9 @@ components: type: string description: A link to the Web API endpoint providing full details of the episode. + html_description: + type: string + description: A description of the episode. This field may contain HTML tags. id: type: string description: "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)\ @@ -7546,6 +7573,8 @@ components: type: string description: "The precision with which `release_date` value is known: `\"\ year\"`, `\"month\"`, or `\"day\"`." + restrictions: + $ref: '#/components/schemas/EpisodeRestrictionObject' resume_point: $ref: '#/components/schemas/ResumePointObject' type: