Skip to content

Commit 4a617b2

Browse files
authored
Update of Spotify's OpenAPI definition (#192)
* Automated update of Spotify's OpenAPI definition * Fix response type of the new "get-audiobook-chapters" operation
1 parent dd48569 commit 4a617b2

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed

fixed-spotify-open-api.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,37 @@ paths:
463463
$ref: '#/components/responses/TooManyRequests'
464464
security:
465465
- oauth_2_0: []
466+
/audiobooks/{id}/chapters:
467+
x-spotify-docs-display-name: audiobook-chapters
468+
x-spotify-docs-category: Audiobooks
469+
get:
470+
operationId: get-audiobook-chapters
471+
tags:
472+
- Audiobooks
473+
- Chapters
474+
x-spotify-docs-endpoint-name: Get an Audiobook's Chapters
475+
x-spotify-docs-console-url: /console/get-audiobook-chapters/?id=5thw29eqjomhIDMY1XKsLk
476+
summary: |
477+
Get Audiobook Chapters
478+
description: |
479+
Get Spotify catalog information about an audiobook's chapters.<br />
480+
**Note: Audiobooks are only available for the US market.**
481+
parameters:
482+
- $ref: '#/components/parameters/PathAudiobookId'
483+
- $ref: '#/components/parameters/QueryMarket'
484+
- $ref: '#/components/parameters/QueryLimit'
485+
- $ref: '#/components/parameters/QueryOffset'
486+
responses:
487+
"200":
488+
$ref: '#/components/responses/ChaptersPagingObject'
489+
"401":
490+
$ref: '#/components/responses/Unauthorized'
491+
"403":
492+
$ref: '#/components/responses/Forbidden'
493+
"429":
494+
$ref: '#/components/responses/TooManyRequests'
495+
security:
496+
- oauth_2_0: []
466497
/chapters/{id}:
467498
x-spotify-docs-display-name: chapters
468499
x-spotify-docs-category: Chapters

official-spotify-open-api.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,38 @@ paths:
478478
security:
479479
-
480480
oauth_2_0: []
481+
/audiobooks/{id}/chapters:
482+
x-spotify-docs-display-name: audiobook-chapters
483+
x-spotify-docs-category: Audiobooks
484+
get:
485+
operationId: get-audiobook-chapters
486+
tags:
487+
- Audiobooks
488+
- Chapters
489+
x-spotify-docs-endpoint-name: Get an Audiobook's Chapters
490+
x-spotify-docs-console-url: /console/get-audiobook-chapters/?id=5thw29eqjomhIDMY1XKsLk
491+
summary: |
492+
Get Audiobook Chapters
493+
description: |
494+
Get Spotify catalog information about an audiobook's chapters.<br />
495+
**Note: Audiobooks are only available for the US market.**
496+
parameters:
497+
- $ref: '#/components/parameters/PathAudiobookId'
498+
- $ref: '#/components/parameters/QueryMarket'
499+
- $ref: '#/components/parameters/QueryLimit'
500+
- $ref: '#/components/parameters/QueryOffset'
501+
responses:
502+
"200":
503+
$ref: "#/components/responses/PagingObject"
504+
"401":
505+
$ref: "#/components/responses/Unauthorized"
506+
"403":
507+
$ref: "#/components/responses/Forbidden"
508+
"429":
509+
$ref: "#/components/responses/TooManyRequests"
510+
security:
511+
-
512+
oauth_2_0: []
481513
/chapters/{id}:
482514
x-spotify-docs-display-name: chapters
483515
x-spotify-docs-category: Chapters
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
description: update response type to ChaptersPagingObject
2+
operations:
3+
- op: test
4+
path: "$.paths./audiobooks/{id}/chapters.get.responses.200.$ref"
5+
value: '#/components/responses/PagingObject'
6+
- op: set
7+
path: "$.paths./audiobooks/{id}/chapters.get.responses.200.$ref"
8+
value: '#/components/responses/ChaptersPagingObject'

0 commit comments

Comments
 (0)