Config Schema¶

path

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	config.schema.json

Config Type¶

object (Config)

Config Properties¶

Property	Type	Required	Nullable	Defined by
artist_listened_to	Multiple	Optional	can be null	Config
bumps	`array`	Optional	cannot be null	Config
commands	Merged	Optional	cannot be null	Config
default_user	`string`	Optional	can be null	Config
interzic	`object`	Optional	cannot be null	Config
listenbrainz_domain	`string`	Optional	cannot be null	Config
listens	`object`	Optional	cannot be null	Config
mapper	Merged	Optional	cannot be null	Config
musicbrainz_server	Merged	Optional	cannot be null	Config
musicbrainz_url	`string`	Optional	can be null	Config
tokens	`object`	Required	cannot be null	Config

artist_listened_to¶

artist_listened_to

is optional
Type: any of the following: string or number (Details)
can be null
defined in: Config

artist_listened_to Type¶

any of the following: string or number (Details)

artist_listened_to Constraints¶

pattern: the string must match the following regular expression:

^-?\d+(\.\d+)?([eE]\d+)?$

try pattern

bumps¶

bumps

is optional
Type: object[] (Details)
cannot be null
defined in: Config

bumps Type¶

object[] (Details)

bumps Default Value¶

The default value is:

[]

commands¶

commands

is optional
Type: merged type (Details)
cannot be null
defined in: Config

commands Type¶

merged type (Details)

any of

default_user¶

default_user

is optional
Type: string
can be null
defined in: Config

default_user Type¶

string

interzic¶

interzic

is optional
Type: object (Details)
cannot be null
defined in: Config

interzic Type¶

object (Details)

interzic Default Value¶

The default value is:

{
  "subsonic_clients": []
}

listenbrainz_domain¶

listenbrainz_domain

is optional
Type: string
cannot be null
defined in: Config

listenbrainz_domain Type¶

string

listenbrainz_domain Default Value¶

The default value is:

"api.listenbrainz.org"

listens¶

listens

is optional
Type: object (Details)
cannot be null
defined in: Config

listens Type¶

object (Details)

listens Default Value¶

The default value is:

{
  "refresh_unmapped_listens": true
}

mapper¶

mapper

is optional
Type: merged type (Details)
cannot be null
defined in: Config

mapper Type¶

merged type (Details)

any of

musicbrainz_server¶

musicbrainz_server

is optional
Type: merged type (Details)
cannot be null
defined in: Config

musicbrainz_server Type¶

merged type (Details)

any of

musicbrainz_url¶

musicbrainz_url

is optional
Type: string
can be null
defined in: Config

musicbrainz_url Type¶

string

tokens¶

Saved usertokens

tokens

is required
Type: object (Details)
cannot be null
defined in: Config

tokens Type¶

object (Details)

Config Definitions¶

Definitions group Bump¶

Reference this group by using

{"$ref":"path#/$defs/Bump"}

Property	Type	Required	Nullable	Defined by
expiration_date	`string`	Required	cannot be null	Config
recording	`string`	Required	cannot be null	Config
username	`string`	Required	cannot be null	Config
value	Multiple	Required	cannot be null	Config

expiration_date¶

expiration_date

is required
Type: string
cannot be null
defined in: Config

expiration_date Type¶

string

expiration_date Constraints¶

date time: the string must be a date time string, according to RFC 3339, section 5.6

recording¶

recording

is required
Type: string
cannot be null
defined in: Config

recording Type¶

string

username¶

username

is required
Type: string
cannot be null
defined in: Config

username Type¶

string

value¶

value

is required
Type: any of the following: string or number (Details)
cannot be null
defined in: Config

value Type¶

any of the following: string or number (Details)

value Constraints¶

pattern: the string must match the following regular expression:

^-?\d+(\.\d+)?([eE]\d+)?$

try pattern

Definitions group BumpList¶

Reference this group by using

{"$ref":"path#/$defs/BumpList"}

Property	Type	Required	Nullable	Defined by

Definitions group CommandConfig¶

Reference this group by using

{"$ref":"path#/$defs/CommandConfig"}

Property	Type	Required	Nullable	Defined by
daily	Merged	Optional	cannot be null	Config

daily¶

daily

is optional
Type: merged type (Details)
cannot be null
defined in: Config

daily Type¶

merged type (Details)

any of

Definitions group DailyCommandConfig¶

Reference this group by using

{"$ref":"path#/$defs/DailyCommandConfig"}

Property	Type	Required	Nullable	Defined by
minimum_listens	`integer`	Optional	can be null	Config

minimum_listens¶

The minimum listens needed to display a track's anniversary / first discovery

minimum_listens

is optional
Type: integer
can be null
defined in: Config

minimum_listens Type¶

integer

minimum_listens Constraints¶

minimum: the value of this number must greater than or equal to: 0

unknown format: the value of this string must follow the format: uint

Definitions group InterzicConfig¶

Reference this group by using

{"$ref":"path#/$defs/InterzicConfig"}

Property	Type	Required	Nullable	Defined by
subsonic_clients	`array`	Required	cannot be null	Config

subsonic_clients¶

subsonic_clients

is required
Type: object[] (Details)
cannot be null
defined in: Config

subsonic_clients Type¶

object[] (Details)

Definitions group ListenConfig¶

Reference this group by using

{"$ref":"path#/$defs/ListenConfig"}

Property	Type	Required	Nullable	Defined by
refresh_unmapped_listens	`boolean`	Required	cannot be null	Config

refresh_unmapped_listens¶

refresh_unmapped_listens

is required
Type: boolean
cannot be null
defined in: Config

refresh_unmapped_listens Type¶

boolean

Definitions group MapperConfig¶

Reference this group by using

{"$ref":"path#/$defs/MapperConfig"}

Property	Type	Required	Nullable	Defined by
backlisted	`array`	Required	cannot be null	Config

backlisted¶

List of recordings that shouldn't be proposed to be mapped

backlisted

is required
Type: string[]
cannot be null
defined in: Config

backlisted Type¶

string[]

Definitions group MusicbrainzServer¶

Reference this group by using

{"$ref":"path#/$defs/MusicbrainzServer"}

Property	Type	Required	Nullable	Defined by
authority	`string`	Required	cannot be null	Config
ratelimit	Merged	Optional	cannot be null	Config
use_https	`boolean`	Required	cannot be null	Config

authority¶

authority

is required
Type: string
cannot be null
defined in: Config

authority Type¶

string

ratelimit¶

ratelimit

is optional
Type: merged type (Details)
cannot be null
defined in: Config

ratelimit Type¶

merged type (Details)

any of

use_https¶

use_https

is required
Type: boolean
cannot be null
defined in: Config

use_https Type¶

boolean

Definitions group RateLimitConfig¶

Reference this group by using

{"$ref":"path#/$defs/RateLimitConfig"}

Property	Type	Required	Nullable	Defined by
each	`integer`	Required	cannot be null	Config
max_burst	`integer`	Optional	can be null	Config
tokens	`integer`	Required	cannot be null	Config

each¶

each

is required
Type: integer
cannot be null
defined in: Config

each Type¶

integer

each Constraints¶

minimum: the value of this number must greater than or equal to: 0

unknown format: the value of this string must follow the format: uint32

max_burst¶

max_burst

is optional
Type: integer
can be null
defined in: Config

max_burst Type¶

integer

max_burst Constraints¶

minimum: the value of this number must greater than or equal to: 0

unknown format: the value of this string must follow the format: uint32

tokens¶

tokens

is required
Type: integer
cannot be null
defined in: Config

tokens Type¶

integer

tokens Constraints¶

minimum: the value of this number must greater than or equal to: 0

unknown format: the value of this string must follow the format: uint32

Definitions group SubsonicConfig¶

Reference this group by using

{"$ref":"path#/$defs/SubsonicConfig"}

Property	Type	Required	Nullable	Defined by
name	`string`	Required	cannot be null	Config
password	`string`	Required	cannot be null	Config
strict_mbid	`boolean`	Optional	can be null	Config
url	`string`	Required	cannot be null	Config
username	`string`	Required	cannot be null	Config

name¶

The name of the subsonic instance

name

is required
Type: string
cannot be null
defined in: Config

name Type¶

string

password¶

The password of the user

password

is required
Type: string
cannot be null
defined in: Config

password Type¶

string

strict_mbid¶

If set to true, only subsonic tracks that match the MBID of the requested recording are mapped

Only set this if your subsonic server is capable of searching by MBID (Like navidrome), and your collection has been passed through Musicbrainz Picard

strict_mbid

is optional
Type: boolean
can be null
defined in: Config

strict_mbid Type¶

boolean

url¶

The url of the subsonic instance

url

is required
Type: string
cannot be null
defined in: Config

url Type¶

string

username¶

The username of the user

username

is required
Type: string
cannot be null
defined in: Config

username Type¶

string