Sansan
2c3e97190d
- New /api/v1 endpoints: GET /soundtracks, /soundtracks/{uuid},
/songs/{uuid} and /songs/{uuid}/file (streams the song, Range support,
locked during sync)
- UUIDs added to every response with soundtracks or songs: queue info and
list (SoundtrackUuid, SongUuid) and statistics (soundtrack_uuid,
song_uuid). Existing fields stay for backward compatibility
- Play counts and broken-song removal use song UUIDs instead of
soundtrack ID + song name, so songs with the same name are counted
separately
- Statistics return an empty song list for soundtracks without songs
instead of a single empty entry
- The legacy .id file cleanup stays until Phase 4 (#31)
Closes #29
1157 lines
27 KiB
YAML
1157 lines
27 KiB
YAML
basePath: /
|
|
definitions:
|
|
backend.Song:
|
|
properties:
|
|
file_name:
|
|
type: string
|
|
name:
|
|
type: string
|
|
soundtrack_name:
|
|
type: string
|
|
soundtrack_uuid:
|
|
type: string
|
|
times_played:
|
|
type: integer
|
|
uuid:
|
|
type: string
|
|
type: object
|
|
backend.SongInfo:
|
|
properties:
|
|
CurrentlyPlaying:
|
|
type: boolean
|
|
Song:
|
|
type: string
|
|
SongNo:
|
|
type: integer
|
|
SongPlayed:
|
|
type: integer
|
|
SongUuid:
|
|
type: string
|
|
Soundtrack:
|
|
type: string
|
|
SoundtrackPlayed:
|
|
type: integer
|
|
SoundtrackUuid:
|
|
type: string
|
|
type: object
|
|
backend.SongInfoForStats:
|
|
properties:
|
|
file_name:
|
|
type: string
|
|
path:
|
|
type: string
|
|
song_name:
|
|
type: string
|
|
song_uuid:
|
|
type: string
|
|
soundtrack_id:
|
|
type: integer
|
|
soundtrack_name:
|
|
type: string
|
|
soundtrack_uuid:
|
|
type: string
|
|
times_played:
|
|
type: integer
|
|
type: object
|
|
backend.Soundtrack:
|
|
properties:
|
|
added:
|
|
type: string
|
|
last_played:
|
|
type: string
|
|
name:
|
|
type: string
|
|
times_played:
|
|
type: integer
|
|
uuid:
|
|
type: string
|
|
type: object
|
|
backend.SoundtrackWithSongList:
|
|
properties:
|
|
added:
|
|
type: string
|
|
last_played:
|
|
type: string
|
|
name:
|
|
type: string
|
|
songs:
|
|
items:
|
|
$ref: '#/definitions/backend.Song'
|
|
type: array
|
|
times_played:
|
|
type: integer
|
|
uuid:
|
|
type: string
|
|
type: object
|
|
backend.SoundtrackWithSongs:
|
|
properties:
|
|
songs:
|
|
items:
|
|
$ref: '#/definitions/backend.SongInfoForStats'
|
|
type: array
|
|
soundtrack_id:
|
|
type: integer
|
|
soundtrack_last_played:
|
|
type: string
|
|
soundtrack_name:
|
|
type: string
|
|
soundtrack_played:
|
|
type: integer
|
|
soundtrack_uuid:
|
|
type: string
|
|
type: object
|
|
backend.StatisticsSummary:
|
|
properties:
|
|
avg_soundtrack_plays:
|
|
type: number
|
|
max_soundtrack_plays:
|
|
type: integer
|
|
min_soundtrack_plays:
|
|
type: integer
|
|
never_played_soundtracks:
|
|
type: integer
|
|
played_soundtracks:
|
|
type: integer
|
|
total_soundtrack_plays:
|
|
type: integer
|
|
total_soundtracks:
|
|
type: integer
|
|
type: object
|
|
backend.SyncResponse:
|
|
properties:
|
|
catched_errors:
|
|
items:
|
|
type: string
|
|
type: array
|
|
soundtracks_added:
|
|
items:
|
|
type: string
|
|
type: array
|
|
soundtracks_changed_content:
|
|
items:
|
|
type: string
|
|
type: array
|
|
soundtracks_changed_title:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
soundtracks_re_added:
|
|
items:
|
|
type: string
|
|
type: array
|
|
soundtracks_removed:
|
|
items:
|
|
type: string
|
|
type: array
|
|
total_time:
|
|
type: string
|
|
type: object
|
|
backend.VersionData:
|
|
properties:
|
|
changelog:
|
|
example:
|
|
- '["Initial release"'
|
|
- '"Bug fixes"]'
|
|
items:
|
|
type: string
|
|
type: array
|
|
version:
|
|
example: 1.0.0
|
|
type: string
|
|
type: object
|
|
server.TokenRequest:
|
|
properties:
|
|
client_type:
|
|
description: 'Optional: "web", "mobile", "api"'
|
|
type: string
|
|
password:
|
|
description: API password, required when API_PASSWORD is set
|
|
type: string
|
|
type: object
|
|
server.TokenResponse:
|
|
properties:
|
|
client_type:
|
|
type: string
|
|
expires_at:
|
|
type: string
|
|
token:
|
|
type: string
|
|
type: object
|
|
info:
|
|
contact:
|
|
email: zarnor91@gmail.com
|
|
name: Sebastian Olsson
|
|
description: API for the MusicServer application
|
|
license:
|
|
name: MIT
|
|
url: http://opensource.org/licenses/MIT
|
|
termsOfService: http://sanplex.xyz/terms/
|
|
title: MusicServer API
|
|
version: "1.0"
|
|
paths:
|
|
/api/v1/songs/{uuid}:
|
|
get:
|
|
description: Returns information about a song
|
|
parameters:
|
|
- description: Song UUID
|
|
in: path
|
|
name: uuid
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/backend.Song'
|
|
"400":
|
|
description: invalid uuid
|
|
schema:
|
|
type: string
|
|
"404":
|
|
description: not found
|
|
schema:
|
|
type: string
|
|
summary: Get song
|
|
tags:
|
|
- library
|
|
/api/v1/songs/{uuid}/file:
|
|
get:
|
|
description: Returns the audio file of a song. Supports Range requests.
|
|
parameters:
|
|
- description: Song UUID
|
|
in: path
|
|
name: uuid
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"206":
|
|
description: Partial Content
|
|
schema:
|
|
type: file
|
|
"400":
|
|
description: invalid uuid
|
|
schema:
|
|
type: string
|
|
"404":
|
|
description: not found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Stream song
|
|
tags:
|
|
- library
|
|
/api/v1/soundtracks:
|
|
get:
|
|
description: Returns all soundtracks with their UUIDs, sorted by name
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.Soundtrack'
|
|
type: array
|
|
summary: List soundtracks
|
|
tags:
|
|
- library
|
|
/api/v1/soundtracks/{uuid}:
|
|
get:
|
|
description: Returns a soundtrack with its songs
|
|
parameters:
|
|
- description: Soundtrack UUID
|
|
in: path
|
|
name: uuid
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/backend.SoundtrackWithSongList'
|
|
"400":
|
|
description: invalid uuid
|
|
schema:
|
|
type: string
|
|
"404":
|
|
description: not found
|
|
schema:
|
|
type: string
|
|
summary: Get soundtrack
|
|
tags:
|
|
- library
|
|
/api/v1/statistics/songs/least-played:
|
|
get:
|
|
description: Returns the top N least played songs with their soundtrack info
|
|
parameters:
|
|
- description: 'Number of results (default: 10, max: 100)'
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SongInfoForStats'
|
|
type: array
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get least played songs
|
|
tags:
|
|
- statistics
|
|
/api/v1/statistics/songs/most-played:
|
|
get:
|
|
description: Returns the top N most played songs with their soundtrack info
|
|
parameters:
|
|
- description: 'Number of results (default: 10, max: 100)'
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SongInfoForStats'
|
|
type: array
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get most played songs
|
|
tags:
|
|
- statistics
|
|
/api/v1/statistics/soundtracks/last-played:
|
|
get:
|
|
description: Returns the most recently played soundtracks with their songs
|
|
parameters:
|
|
- description: 'Number of results (default: 10, max: 100)'
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SoundtrackWithSongs'
|
|
type: array
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get last played soundtracks
|
|
tags:
|
|
- statistics
|
|
/api/v1/statistics/soundtracks/least-played:
|
|
get:
|
|
description: Returns the top N least played soundtracks with their songs
|
|
parameters:
|
|
- description: 'Number of results (default: 10, max: 100)'
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SoundtrackWithSongs'
|
|
type: array
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get least played soundtracks
|
|
tags:
|
|
- statistics
|
|
/api/v1/statistics/soundtracks/most-played:
|
|
get:
|
|
description: Returns the top N most played soundtracks with their songs
|
|
parameters:
|
|
- description: 'Number of results (default: 10, max: 100)'
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SoundtrackWithSongs'
|
|
type: array
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get most played soundtracks
|
|
tags:
|
|
- statistics
|
|
/api/v1/statistics/soundtracks/never-played:
|
|
get:
|
|
description: Returns all soundtracks that have never been played
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SoundtrackWithSongs'
|
|
type: array
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get never played soundtracks
|
|
tags:
|
|
- statistics
|
|
/api/v1/statistics/soundtracks/oldest-played:
|
|
get:
|
|
description: Returns the least recently played soundtracks with their songs
|
|
parameters:
|
|
- description: 'Number of results (default: 10, max: 100)'
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SoundtrackWithSongs'
|
|
type: array
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get oldest played soundtracks
|
|
tags:
|
|
- statistics
|
|
/api/v1/statistics/summary:
|
|
get:
|
|
description: Returns overall play statistics
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/backend.StatisticsSummary'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Get statistics summary
|
|
tags:
|
|
- statistics
|
|
/api/v1/token:
|
|
delete:
|
|
description: Deletes the current session token
|
|
parameters:
|
|
- description: Bearer token
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Invalidate session token
|
|
tags:
|
|
- auth
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Returns a new session token for API access. Requires the API password
|
|
when one is configured.
|
|
parameters:
|
|
- description: Password and client type
|
|
in: body
|
|
name: request
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/server.TokenRequest'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/server.TokenResponse'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"429":
|
|
description: Too Many Requests
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Create session token
|
|
tags:
|
|
- auth
|
|
/api/v1/token/cleanup:
|
|
post:
|
|
description: Removes all expired session tokens from the database
|
|
parameters:
|
|
- description: Bearer token
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Cleanup expired sessions
|
|
tags:
|
|
- auth
|
|
/character:
|
|
get:
|
|
description: Returns the image for a specific character
|
|
parameters:
|
|
- description: Character file name
|
|
in: query
|
|
name: name
|
|
required: true
|
|
type: string
|
|
produces:
|
|
- image/png
|
|
- image/jpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"400":
|
|
description: invalid name
|
|
schema:
|
|
type: string
|
|
"404":
|
|
description: not found
|
|
schema:
|
|
type: string
|
|
summary: Get character image
|
|
tags:
|
|
- characters
|
|
/characters:
|
|
get:
|
|
description: Returns a list of all available characters
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
type: string
|
|
type: array
|
|
summary: Get list of characters
|
|
tags:
|
|
- characters
|
|
/download:
|
|
get:
|
|
description: Returns the latest version of the client application
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: string
|
|
"502":
|
|
description: upstream service unavailable
|
|
schema:
|
|
type: string
|
|
summary: Check for latest version
|
|
tags:
|
|
- download
|
|
/download/linux:
|
|
get:
|
|
description: Redirects to download the latest Linux version
|
|
responses:
|
|
"302":
|
|
description: Found
|
|
schema:
|
|
type: string
|
|
"404":
|
|
description: not found
|
|
schema:
|
|
type: string
|
|
"502":
|
|
description: upstream service unavailable
|
|
schema:
|
|
type: string
|
|
summary: Download latest Linux version
|
|
tags:
|
|
- download
|
|
/download/list:
|
|
get:
|
|
description: Lists all assets available for the latest version
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
type: string
|
|
type: array
|
|
"502":
|
|
description: upstream service unavailable
|
|
schema:
|
|
type: string
|
|
summary: List assets of latest version
|
|
tags:
|
|
- download
|
|
/download/windows:
|
|
get:
|
|
description: Redirects to download the latest Windows version
|
|
responses:
|
|
"302":
|
|
description: Found
|
|
schema:
|
|
type: string
|
|
"404":
|
|
description: not found
|
|
schema:
|
|
type: string
|
|
"502":
|
|
description: upstream service unavailable
|
|
schema:
|
|
type: string
|
|
summary: Download latest Windows version
|
|
tags:
|
|
- download
|
|
/health:
|
|
get:
|
|
description: Returns the health status of the server
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
summary: Check server health
|
|
tags:
|
|
- health
|
|
/music:
|
|
get:
|
|
description: Returns the song at the given position in the queue
|
|
parameters:
|
|
- description: Song number in the queue
|
|
in: query
|
|
name: song
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"206":
|
|
description: Partial Content
|
|
schema:
|
|
type: file
|
|
"400":
|
|
description: song must be a number
|
|
schema:
|
|
type: string
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get a specific song
|
|
tags:
|
|
- music
|
|
/music/addPlayed:
|
|
get:
|
|
description: Marks the current song as played
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Add latest to played
|
|
tags:
|
|
- music
|
|
/music/addQue:
|
|
get:
|
|
description: Adds the latest song to the queue
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Add latest to queue
|
|
tags:
|
|
- music
|
|
/music/all/order:
|
|
get:
|
|
description: Returns a list of all soundtracks in order
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
type: string
|
|
type: array
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get all soundtracks
|
|
tags:
|
|
- music
|
|
/music/all/random:
|
|
get:
|
|
description: Returns a list of all soundtracks in random order
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
type: string
|
|
type: array
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get all soundtracks random
|
|
tags:
|
|
- music
|
|
/music/info:
|
|
get:
|
|
description: Returns information about the current song
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/backend.SongInfo'
|
|
summary: Get current song info
|
|
tags:
|
|
- music
|
|
/music/list:
|
|
get:
|
|
description: Returns a list of played songs
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.SongInfo'
|
|
type: array
|
|
summary: Get played songs list
|
|
tags:
|
|
- music
|
|
/music/next:
|
|
get:
|
|
description: Returns the next song in the queue
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get next song
|
|
tags:
|
|
- music
|
|
/music/played:
|
|
put:
|
|
description: Marks the song at the given queue position as played
|
|
parameters:
|
|
- description: Song number in the queue
|
|
in: query
|
|
name: song
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Mark song as played
|
|
tags:
|
|
- music
|
|
/music/previous:
|
|
get:
|
|
description: Returns the previous song in the queue
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get previous song
|
|
tags:
|
|
- music
|
|
/music/rand:
|
|
get:
|
|
description: Returns a random song
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get random song
|
|
tags:
|
|
- music
|
|
/music/rand/classic:
|
|
get:
|
|
description: Returns a random song where every song has the same chance
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get random classic song
|
|
tags:
|
|
- music
|
|
/music/rand/low:
|
|
get:
|
|
description: Returns a random song, favouring soundtracks that have been played
|
|
less
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get random song with low chance
|
|
tags:
|
|
- music
|
|
/music/reset:
|
|
get:
|
|
description: Resets the music state
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Reset music state
|
|
tags:
|
|
- music
|
|
/music/soundTest:
|
|
get:
|
|
description: Returns the sound check song
|
|
produces:
|
|
- audio/mpeg
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
type: file
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Get sound check song
|
|
tags:
|
|
- music
|
|
/sync:
|
|
post:
|
|
description: Starts syncing soundtracks that have changed
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Start syncing soundtracks
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Sync soundtracks with only changes
|
|
tags:
|
|
- sync
|
|
/sync/full:
|
|
post:
|
|
description: Starts a full sync of all soundtracks
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Start syncing soundtracks full
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Sync all soundtracks fully
|
|
tags:
|
|
- sync
|
|
/sync/progress:
|
|
get:
|
|
description: Returns the progress of the running sync, or the result of the
|
|
last sync
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/backend.SyncResponse'
|
|
summary: Get sync progress
|
|
tags:
|
|
- sync
|
|
/sync/reset:
|
|
post:
|
|
description: Resets the soundtracks database by deleting all soundtracks and
|
|
songs
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Soundtracks and songs are deleted from the database
|
|
schema:
|
|
type: string
|
|
"423":
|
|
description: Syncing is in progress
|
|
schema:
|
|
type: string
|
|
summary: Reset soundtracks database
|
|
tags:
|
|
- sync
|
|
/version:
|
|
get:
|
|
description: get latest version info
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/backend.VersionData'
|
|
summary: Getting the latest version of the backend
|
|
tags:
|
|
- version
|
|
/version/history:
|
|
get:
|
|
description: get version history
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
items:
|
|
$ref: '#/definitions/backend.VersionData'
|
|
type: array
|
|
summary: Getting the version history of the backend
|
|
tags:
|
|
- version
|
|
swagger: "2.0"
|