Change Updates

Do not miss any OSE API changes, ever again

Subscribe to the OSE API changelog to be up to date on recent changes.

RSS
OSE API

Changelog

Last update:
Compare
8 structure changes including:
3 Additions
5 Modifications
Modified 5 Breaking
DELETE /playlists/{playlistId}/songs/{songId}
  • Response
  • 403, 500 responses Added
GET /playlists
  • Query
  • userId query parameter Added
  • Response
  • 403 response Added
GET /playlists/{playlistId}/songs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data, pagination properties Added
  • 403, 500 responses Added
  • Query
  • page, limit query parameters Added
POST /playlists
  • Response
  • 400 response Modified
    • application/json content type Modified
      • errors property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 403, 422 responses Added
POST /playlists/{playlistId}/songs
  • Body
  • application/json content type Modified
    • songId property Modified
      • Property is now required
        Breaking
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 204, 403, 409, 500 responses Added
Added 3
DELETE /playlists/{playlistId}
GET /playlists/{playlistId}
PUT /playlists/{playlistId}
12 structure changes including:
1 Breaking change
1 Addition
10 Modifications
1 Removal
Modified 10 Breaking
GET /playlists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • data property Added
GET /playlists/{playlistId}/songs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Type is no longer string
          Breaking
      • artistIds, genre properties Added
GET /songs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type is no longer string
            Breaking
        • artistIds, genre properties Added
GET /songs/{songId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Type is no longer string
          Breaking
      • artistIds, genre properties Added
GET /users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type is no longer string
            Breaking
GET /users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Type is no longer string
          Breaking
PATCH /songs/{songId}
  • Body
  • application/json content type Modified
    • artistIds, genre properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Type is no longer string
          Breaking
      • artistIds, genre properties Added
POST /playlists
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id property Modified
        • Type is no longer string
          Breaking
      • songIds, songCount properties Added
POST /songs
  • Body
  • application/json content type Modified
    • artistIds, genre properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id property Modified
        • Type is no longer string
          Breaking
      • artistIds, genre properties Added
POST /users
  • Response
  • 201 response Modified
    • application/json content type Modified
      • id property Modified
        • Type is no longer string
          Breaking
Removed 1 Breaking
PATCH /users/{userId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
PUT /users/{userId}
1 structure change including:
1 Addition
Added 1
DELETE /playlists/{playlistId}/songs/{songId}
8 structure changes including:
4 Breaking changes
4 Additions
4 Removals
Removed 4 Breaking
GET /playlists
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /playlists/{playlistId}/songs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /playlists
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /playlists/{playlistId}/songs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
GET /playlists
GET /playlists/{playlistId}/songs
POST /playlists
POST /playlists/{playlistId}/songs
9 structure changes including:
9 Modifications
Modified 9 Breaking
DELETE /artists/{artistId}
  • Response
  • 401 response Modified
    • application/json content type Added
  • 403 response Modified
    • application/json content type Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
DELETE /artists/{artistId}/songs/{songId}
  • Response
  • 401 response Modified
    • application/json content type Added
  • 403 response Modified
    • application/json content type Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
GET /artists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pagination property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 400 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
GET /artists/{artistId}
  • Response
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
GET /artists/{artistId}/songs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pagination property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
PATCH /artists/{artistId}
  • Response
  • 400 response Modified
    • application/json content type Added
  • 401 response Modified
    • application/json content type Added
  • 403 response Modified
    • application/json content type Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
POST /artists
  • Response
  • 400 response Modified
    • application/json content type Added
  • 401 response Modified
    • application/json content type Added
  • 403 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
POST /artists/{artistId}/songs/{songId}
  • Response
  • 400 response Modified
    • application/json content type Added
  • 401 response Modified
    • application/json content type Added
  • 403 response Modified
    • application/json content type Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
PUT /artists/{artistId}
  • Response
  • 400 response Modified
    • application/json content type Added
  • 401 response Modified
    • application/json content type Added
  • 403 response Modified
    • application/json content type Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Added
3 structure changes including:
3 Additions
Added 3
DELETE /songs/{songId}
GET /songs/{songId}
PATCH /songs/{songId}
1 structure change including:
1 Addition
Added 1
POST /songs
1 structure change including:
1 Modification
Modified 1 Breaking
GET /songs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array to object
        Breaking
      • data, pagination properties Added
  • 401, 403, 500 responses Added
  • Query
  • page, limit, search, artistId query parameters Added
10 structure changes including:
1 Breaking change
9 Additions
1 Removal
Removed 1 Breaking
GET /artists
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 9
DELETE /artists/{artistId}
DELETE /artists/{artistId}/songs/{songId}
GET /artists
GET /artists/{artistId}
GET /artists/{artistId}/songs
PATCH /artists/{artistId}
POST /artists
POST /artists/{artistId}/songs/{songId}
PUT /artists/{artistId}
9 structure changes including:
3 Additions
6 Modifications
Modified 6
GET /artists
  • Authentication
  • Bearer auth authentication method Added
GET /playlists
  • Authentication
  • Bearer auth authentication method Added
GET /playlists/{playlistId}/songs
  • Authentication
  • Bearer auth authentication method Added
GET /songs
  • Authentication
  • Bearer auth authentication method Added
POST /playlists
  • Authentication
  • Bearer auth authentication method Added
POST /playlists/{playlistId}/songs
  • Authentication
  • Bearer auth authentication method Added
Added 3
POST /auth/login
POST /auth/logout
POST /auth/refresh
3 structure changes including:
3 Additions
Added 3
DELETE /users/{userId}
GET /users/{userId}
PATCH /users/{userId}
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /users
  • Authentication
  • Bearer auth authentication method Added
Added 1
Bearer authauthentication method
1 structure change including:
1 Modification
Modified 1
POST /users
  • Body
  • application/json content type Modified
    • property Added
  • Response
  • 201, 400, 409, 422, 500 responses Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /users
  • Query
  • role query parameter Added
Added 1
POST /users
1 structure change including:
1 Modification
Modified 1
GET /users
  • Response
  • 200, 401, 403, 500 responses Added
1 structure change including:
1 Modification
Modified 1 Breaking
GET /users
  • Response
  • 200, 401, 403, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
6 structure changes including:
6 Additions
Added 6
GET /artists
GET /playlists
GET /playlists/{playlistId}/songs
GET /songs
POST /playlists
POST /playlists/{playlistId}/songs
1 structure change including:
1 Addition
Added 1
GET /users
1 structure change including:
1 Addition
Added 1
GET /users
1 structure change including:
1 Breaking change
1 Removal
Removed 1 Breaking
GET /users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking