resonatecoop/api

The Great Endpoint Prune of 2022

Opened this issue · 1 comments

I want to propose that we build a list of all endpoints, go through them, analyze which ones can be pruned (maybe it's none!) because they don't get used, which ones have code in them we think we'll need to keep, or which ones should be combined.

Luckily we've got an initial list of endpoints at swagger:

endpoint works? keep? notes
GET /api/v3/artists/updated no ? I'm not sure what the point of this endpoint is. Should be merged in to /api/v3/artists as filter
GET /api/v3/artists/featured no ? Should be merged into /api/v3/artists as a filter
GET /api/v3/artists yes yes
GET /api/v3/artists/{id}/tracks/top yes ?
GET /api/V3/artists/{id}/tracks no ?
GET /api/V3/artists/{id}/releases yes ?
GET /api/V3/artists/{id} yes ?
GET /api/V3/labels no yes
GET /api/V3/labels/{id}/releases no yes
GET /api/V3/labels/{id}/artists no yes
GET /api/V3/labels/{id}/albums no yes
GET /api/V3/labels/{id} no yes
GET /api/V3/playlists yes yes
GET /api/V3/resolve no ? ??? unclear what it does??
GET /api/V3/search no yes
GET /api/V3/tag/{tag} no yes
GET /api/V3/trackgroups yes yes
GET /api/V3/trackgroups/{id} yes yes
GET /api/V3/tracks/latest yes yes
GET /api/V3/tracks yes yes
GET /api/V3/tracks/{id} yes yes
GET /api/V3/apiDocs yes yes
GET /api/v3/user/favorites no yes
GET /api/v3/user/collection/?limit=50&page=1 no yes

Edit: for editability we'll use this doc https://cryptpad.fr/code/#/2/code/edit/sKozHnJxRc89quzgLDQfszil/

GET /api/V3/resolve is currently used to parse urls like this one: https://stream.resonate.coop/artist/12657/release/an-imaginary-journey