OpenSubsonic changes

Documentation

In the documentation all changes from the original Subsonic API will be emphasized with the following warning:

All endpoints or responses modified by the OpenSubsonic API will have [OS] indicator in the navigation menu.

OpenSubsonic server support will documented by a table at the end of the corresponding page. (Ex: search3)

OpenSubsonic expand the original API via 3 different ways:

• Clarifications: Documentation improvement to ensure consistency in server answers or actions where doubt was possible.
• Extensions: Non breaking changes to the API to improve clients life. Like new returned field, or new parameters to existing functions.
• Additions: New endpoints added to provide functions that could not be provided via non breaking extensions.

Required changes

OpenSubsonic is built to be mostly optional to ease the burden on the servers who can’t support some features, while still allowing clients to precisely know what the servers support without having to guess.

To achieve this servers supporting OpenSubsonic have to support a very minimal subset of things.

1. Expand the subsonic-response with the new mandatory fields.
2. Implement the getOpenSubsonicExtensions endpoint.
3. Return error 41 (API Reference) if they do not support Subsonic 1.13.0 new authentification system while advertising a version > 1.13.0

List of changes

Clarifications

List of clarifications

Non breaking changes

List of non breaking changes

Additions

List of additions

Extensions

List of extension