mirror of
https://github.com/navidrome/navidrome.git
synced 2026-02-02 06:24:14 +00:00
120 lines
3.3 KiB
JSON
120 lines
3.3 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://navidrome.org/schemas/Manifest.json",
|
|
"title": "Manifest",
|
|
"description": "Plugin manifest for Navidrome plugins",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": ["name", "author", "version"],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The display name of the plugin",
|
|
"minLength": 1
|
|
},
|
|
"author": {
|
|
"type": "string",
|
|
"description": "The author of the plugin",
|
|
"minLength": 1
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"description": "The version of the plugin (semver recommended)",
|
|
"minLength": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "A brief description of what the plugin does"
|
|
},
|
|
"website": {
|
|
"type": "string",
|
|
"description": "URL to the plugin's website or repository",
|
|
"format": "uri"
|
|
},
|
|
"permissions": {
|
|
"$ref": "#/$defs/Permissions"
|
|
}
|
|
},
|
|
"$defs": {
|
|
"Permissions": {
|
|
"type": "object",
|
|
"description": "Permissions required by the plugin",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"http": {
|
|
"$ref": "#/$defs/HTTPPermission"
|
|
},
|
|
"subsonicapi": {
|
|
"$ref": "#/$defs/SubsonicAPIPermission"
|
|
},
|
|
"scheduler": {
|
|
"$ref": "#/$defs/SchedulerPermission"
|
|
}
|
|
}
|
|
},
|
|
"HTTPPermission": {
|
|
"type": "object",
|
|
"description": "HTTP access permissions for a plugin",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "Explanation for why HTTP access is needed"
|
|
},
|
|
"allowedHosts": {
|
|
"type": "array",
|
|
"description": "List of allowed host patterns for HTTP requests (e.g., 'api.example.com', '*.spotify.com')",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"ConfigPermission": {
|
|
"type": "object",
|
|
"description": "Configuration access permissions for a plugin",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "Explanation for why config access is needed"
|
|
}
|
|
}
|
|
},
|
|
"SubsonicAPIPermission": {
|
|
"type": "object",
|
|
"description": "SubsonicAPI service permissions",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "Explanation for why SubsonicAPI access is needed"
|
|
},
|
|
"allowedUsernames": {
|
|
"type": "array",
|
|
"description": "List of usernames the plugin can pass as u. Any user if empty",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"allowAdmins": {
|
|
"type": "boolean",
|
|
"description": "If false, reject calls where the u is an admin",
|
|
"default": false
|
|
}
|
|
}
|
|
},
|
|
"SchedulerPermission": {
|
|
"type": "object",
|
|
"description": "Scheduler service permissions for scheduling tasks",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "Explanation for why scheduler access is needed"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|