api: Create a couple additional API endpoints #14
Conversation
api.go
Outdated
|
|
||
| func (lapi *Client) GetAssetByPlaybackID(pid string, includeDeleted bool) (*Asset, error) { | ||
| var assets []*Asset | ||
| url := fmt.Sprintf(`%s/api/asset?limit=2&allUsers=true&filters=[{"id":"playbackId","value":%q}]`, lapi.chosenServer, pid) |
There was a problem hiding this comment.
Just curious on why specifically limit 2? When is it possible that there are multiple assets with the same playbackId? I see this is also contemplated as a possible error later on line 1008
There was a problem hiding this comment.
We only care about 3 scenarios:
a. no results, which means we should 404
b. 1 result, meaning we found the asset we want
c. more than 1 result, which means there is an unexpected playback ID conflict
On the last case, we also don't care if we get 2 or 473263672 results, it only matters that there is more than 1.
In such case, we can limit the list to 2 elements in the response, which gives us only 3 possibilites of responses:
- 0 elements (a)
- 1 element (b)
- 2 elements (c)
We also avoid some data bandwidth in case there is this bug of more than 1 asset with the same playbackId, transferring only 2 elements over the internet (doesn't matter how much there really are).
I don't know how that case could happen, but it is a safeguard since we're using a List function for what is actually a Get. If we get more than 1 asset, it's an internal server error and we should treat it as such.
This is to create a couple of additional API endpoints that were needed for writing
a script to unpin items from IPFS created by our VOD tests.