Skip to content

Commit a4cd81c

Browse files
sonalluxgithub-actions[bot]
authored andcommitted
Automated update of Spotify's OpenAPI definition
1 parent 95758cc commit a4cd81c

File tree

2 files changed

+45
-25
lines changed

2 files changed

+45
-25
lines changed

fixed-spotify-open-api.yml

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -843,7 +843,7 @@ paths:
843843
public:
844844
type: boolean
845845
description: |
846-
If `true` the playlist will be public, if `false` it will be private.
846+
The playlist's public/private status (if it should be added to the user's profile or not): `true` the playlist will be public, `false` the playlist will be private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
847847
collaborative:
848848
type: boolean
849849
description: |
@@ -1744,7 +1744,7 @@ paths:
17441744
public:
17451745
type: boolean
17461746
description: |
1747-
Defaults to `true`. If `true` the playlist will be public, if `false` it will be private. To be able to create private playlists, the user must have granted the `playlist-modify-private` [scope](/documentation/web-api/concepts/scopes/#list-of-scopes)
1747+
Defaults to `true`. The playlist's public/private status (if it should be added to the user's profile or not): `true` the playlist will be public, `false` the playlist will be private. To be able to create private playlists, the user must have granted the `playlist-modify-private` [scope](/documentation/web-api/concepts/scopes/#list-of-scopes). For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
17481748
collaborative:
17491749
type: boolean
17501750
description: |
@@ -1790,7 +1790,7 @@ paths:
17901790
public:
17911791
type: boolean
17921792
description: |
1793-
Defaults to `true`. If `true` the playlist will be included in user's public playlists, if `false` it will remain private.
1793+
Defaults to `true`. If `true` the playlist will be included in user's public playlists (added to profile), if `false` it will remain private. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
17941794
responses:
17951795
"200":
17961796
description: Playlist followed
@@ -2258,23 +2258,23 @@ paths:
22582258
- Playlists
22592259
operationId: check-if-user-follows-playlist
22602260
summary: |
2261-
Check if Users Follow Playlist
2261+
Check if Current User Follows Playlist
22622262
description: |
2263-
Check to see if one or more Spotify users are following a specified playlist.
2263+
Check to see if the current user is following a specified playlist.
22642264
parameters:
22652265
- $ref: '#/components/parameters/PathPlaylistId'
22662266
- name: ids
2267-
required: true
2267+
required: false
22682268
in: query
22692269
schema:
22702270
title: Spotify user IDs
22712271
description: |
2272-
A comma-separated list of [Spotify User IDs](/documentation/web-api/concepts/spotify-uris-ids) ; the ids of the users that you want to check to see if they follow the playlist. Maximum: 5 ids.
2273-
example: "jmperezperez,thelinmichael,wizzler"
2272+
**Deprecated** A single item list containing current user's [Spotify Username](/documentation/web-api/concepts/spotify-uris-ids). Maximum: 1 id.
2273+
example: jmperezperez
22742274
type: string
22752275
responses:
22762276
"200":
2277-
$ref: '#/components/responses/ArrayOfBooleans'
2277+
$ref: '#/components/responses/SingletonArrayOfBoolean'
22782278
"401":
22792279
$ref: '#/components/responses/Unauthorized'
22802280
"403":
@@ -3985,6 +3985,16 @@ components:
39853985
- true
39863986
items:
39873987
type: boolean
3988+
SingletonArrayOfBoolean:
3989+
description: "Array of boolean, containing a single boolean"
3990+
content:
3991+
application/json:
3992+
schema:
3993+
type: array
3994+
example:
3995+
- true
3996+
items:
3997+
type: boolean
39883998
Queue:
39893999
description: Information about the queue
39904000
content:
@@ -4301,8 +4311,8 @@ components:
43014311
description: A Context Object. Can be `null`.
43024312
timestamp:
43034313
type: integer
4304-
description: Unix Millisecond Timestamp when data was fetched.
4305-
format: int64
4314+
description: "Unix Millisecond Timestamp when playback state was last changed\
4315+
\ (play, pause, skip, scrub, new song, etc.)."
43064316
progress_ms:
43074317
type: integer
43084318
description: Progress into the currently playing track or episode. Can be
@@ -5531,7 +5541,7 @@ components:
55315541
public:
55325542
type: boolean
55335543
description: |
5534-
The playlist's public/private status: `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
5544+
The playlist's public/private status (if it is added to the user's profile): `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
55355545
snapshot_id:
55365546
type: string
55375547
description: |
@@ -5593,7 +5603,7 @@ components:
55935603
public:
55945604
type: boolean
55955605
description: |
5596-
The playlist's public/private status: `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
5606+
The playlist's public/private status (if it is added to the user's profile): `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
55975607
snapshot_id:
55985608
type: string
55995609
description: |

official-spotify-open-api.yml

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -889,7 +889,7 @@ paths:
889889
public:
890890
type: boolean
891891
description: |
892-
If `true` the playlist will be public, if `false` it will be private.
892+
The playlist's public/private status (if it should be added to the user's profile or not): `true` the playlist will be public, `false` the playlist will be private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
893893
collaborative:
894894
type: boolean
895895
description: |
@@ -1798,7 +1798,7 @@ paths:
17981798
public:
17991799
type: boolean
18001800
description: |
1801-
Defaults to `true`. If `true` the playlist will be public, if `false` it will be private. To be able to create private playlists, the user must have granted the `playlist-modify-private` [scope](/documentation/web-api/concepts/scopes/#list-of-scopes)
1801+
Defaults to `true`. The playlist's public/private status (if it should be added to the user's profile or not): `true` the playlist will be public, `false` the playlist will be private. To be able to create private playlists, the user must have granted the `playlist-modify-private` [scope](/documentation/web-api/concepts/scopes/#list-of-scopes). For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
18021802
collaborative:
18031803
type: boolean
18041804
description: |
@@ -1844,7 +1844,7 @@ paths:
18441844
public:
18451845
type: boolean
18461846
description: |
1847-
Defaults to `true`. If `true` the playlist will be included in user's public playlists, if `false` it will remain private.
1847+
Defaults to `true`. If `true` the playlist will be included in user's public playlists (added to profile), if `false` it will remain private. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
18481848
responses:
18491849
'200':
18501850
description: Playlist followed
@@ -2329,23 +2329,23 @@ paths:
23292329
- Playlists
23302330
operationId: check-if-user-follows-playlist
23312331
summary: |
2332-
Check if Users Follow Playlist
2332+
Check if Current User Follows Playlist
23332333
description: |
2334-
Check to see if one or more Spotify users are following a specified playlist.
2334+
Check to see if the current user is following a specified playlist.
23352335
parameters:
23362336
- $ref: '#/components/parameters/PathPlaylistId'
23372337
- name: ids
2338-
required: true
2338+
required: false
23392339
in: query
23402340
schema:
23412341
title: Spotify user IDs
23422342
description: |
2343-
A comma-separated list of [Spotify User IDs](/documentation/web-api/concepts/spotify-uris-ids) ; the ids of the users that you want to check to see if they follow the playlist. Maximum: 5 ids.
2344-
example: jmperezperez,thelinmichael,wizzler
2343+
**Deprecated** A single item list containing current user's [Spotify Username](/documentation/web-api/concepts/spotify-uris-ids). Maximum: 1 id.
2344+
example: jmperezperez
23452345
type: string
23462346
responses:
23472347
'200':
2348-
$ref: '#/components/responses/ArrayOfBooleans'
2348+
$ref: '#/components/responses/SingletonArrayOfBoolean'
23492349
'401':
23502350
$ref: '#/components/responses/Unauthorized'
23512351
'403':
@@ -4118,6 +4118,16 @@ components:
41184118
items:
41194119
type: boolean
41204120

4121+
SingletonArrayOfBoolean:
4122+
description: Array of boolean, containing a single boolean
4123+
content:
4124+
application/json:
4125+
schema:
4126+
type: array
4127+
example: [true]
4128+
items:
4129+
type: boolean
4130+
41214131
Queue:
41224132
description: Information about the queue
41234133
content:
@@ -4411,7 +4421,7 @@ components:
44114421
description: A Context Object. Can be `null`.
44124422
timestamp:
44134423
type: integer
4414-
description: Unix Millisecond Timestamp when data was fetched.
4424+
description: Unix Millisecond Timestamp when playback state was last changed (play, pause, skip, scrub, new song, etc.).
44154425
progress_ms:
44164426
type: integer
44174427
description: Progress into the currently playing track or episode. Can be `null`.
@@ -5598,7 +5608,7 @@ components:
55985608
public:
55995609
type: boolean
56005610
description: |
5601-
The playlist's public/private status: `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
5611+
The playlist's public/private status (if it is added to the user's profile): `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
56025612
snapshot_id:
56035613
type: string
56045614
description: |
@@ -5661,7 +5671,7 @@ components:
56615671
public:
56625672
type: boolean
56635673
description: |
5664-
The playlist's public/private status: `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
5674+
The playlist's public/private status (if it is added to the user's profile): `true` the playlist is public, `false` the playlist is private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)
56655675
snapshot_id:
56665676
type: string
56675677
description: |

0 commit comments

Comments
 (0)