Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 157 additions & 0 deletions api-spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,84 @@ components:
type: array
items:
$ref: '#/components/schemas/libraryPlaylist'
libraryAlbum:
x-go-name: ApiLibraryAlbum
description: An album saved in the user's library
type: object
required: [ uri, name, artist_names, year, image_url ]
properties:
uri:
description: Album URI
type: string
name:
description: Album name, empty when its metadata could not be read
type: string
artist_names:
description: Names of the album artists
type: array
items:
type: string
year:
description: Release year, zero when unknown
type: integer
image_url:
description: Cover image URL, null when unknown
type: string
nullable: true
libraryAlbums:
x-go-name: ApiLibraryAlbums
description: A page of the user's saved albums
type: object
required: [ total, offset, limit, items ]
properties:
total:
description: Number of saved albums
type: integer
offset:
description: Index of the first returned album
type: integer
limit:
description: Maximum number of albums requested
type: integer
items:
type: array
items:
$ref: '#/components/schemas/libraryAlbum'
libraryArtist:
x-go-name: ApiLibraryArtist
description: An artist the user follows
type: object
required: [ uri, name, image_url ]
properties:
uri:
description: Artist URI
type: string
name:
description: Artist name, empty when its metadata could not be read
type: string
image_url:
description: Portrait image URL, null when unknown
type: string
nullable: true
libraryArtists:
x-go-name: ApiLibraryArtists
description: A page of the artists the user follows
type: object
required: [ total, offset, limit, items ]
properties:
total:
description: Number of followed artists
type: integer
offset:
description: Index of the first returned artist
type: integer
limit:
description: Maximum number of artists requested
type: integer
items:
type: array
items:
$ref: '#/components/schemas/libraryArtist'
likedState:
x-go-name: ApiLikedState
description: Whether a track is in the user's Liked Songs
Expand Down Expand Up @@ -760,6 +838,85 @@ paths:
description: No active session
400:
description: The offset or limit is out of range
/library/albums:
get:
operationId: getLibraryAlbums
description: >-
List the albums saved in the user's library, most recently saved
first. The list comes from the internal collection service and the
album details from extended metadata, not the rate-limited public Web
API.
parameters:
- name: offset
in: query
required: false
description: Index of the first item to return
schema:
type: integer
minimum: 0
default: 0
x-go-type-skip-optional-pointer: true
- name: limit
in: query
required: false
description: Maximum number of items to return, from 1 to 500
schema:
type: integer
minimum: 1
maximum: 500
default: 50
x-go-type-skip-optional-pointer: true
responses:
200:
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/libraryAlbums'
204:
description: No active session
400:
description: The offset or limit is out of range
/library/artists:
get:
operationId: getLibraryArtists
description: >-
List the artists the user follows, most recently followed first. The
list comes from the internal collection service and the artist
details from extended metadata, not the rate-limited public Web API.
Play an artist, or list its tracks through /context/tracks, with its
URI.
parameters:
- name: offset
in: query
required: false
description: Index of the first item to return
schema:
type: integer
minimum: 0
default: 0
x-go-type-skip-optional-pointer: true
- name: limit
in: query
required: false
description: Maximum number of items to return, from 1 to 500
schema:
type: integer
minimum: 1
maximum: 500
default: 50
x-go-type-skip-optional-pointer: true
responses:
200:
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/libraryArtists'
204:
description: No active session
400:
description: The offset or limit is out of range
/library/liked:
get:
operationId: getLiked
Expand Down
154 changes: 154 additions & 0 deletions daemon/api_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading