Source collected by query parameter#183
Conversation
| This behaviour focuses on starting from a known Flow to which the collection is applied. | ||
| There is no equivalent endpoints at the Source level. | ||
|
|
||
| If chosen to also apply at the Flow level then need to consider is `flows_collected_by_id=a46c49f1-4764-42b9-9f91-f267a58903c4` too similar to `/flows/a46c49f1-4764-42b9-9f91-f267a58903c4/flow_collection`? |
There was a problem hiding this comment.
The distinction kinda comes up for the role discussion in #173 - the query string parameter lets you search for more things, for example /flows?flows_collected_by_id=<uuid>&format=urn:x-nmos:format:video&codec=video/h264 which feels useful, while the flows/<uuid>/flow_collection is the canonical resource itself - you can edit it there
|
TSC 2026-05-01 |
|
TSC 2026-05-29 |
j616
left a comment
There was a problem hiding this comment.
Nice work. One question and a couple of minor suggestions.
| description: Filter on Source format. | ||
| schema: | ||
| $ref: 'schemas/content-format.json' | ||
| - name: collected_by_ids |
There was a problem hiding this comment.
Do we want a collects_ids equivalent that goes in the opposite direction?
I think we also mused about a collected_by_source/flow_ids parameter that might query Flows/Sources by collections at the other level. But maybe thats a step too far...
There was a problem hiding this comment.
Is GET /sources/<sourceId> and then reading source_collection sufficient for that first part?
There was a problem hiding this comment.
I think its the other way around. I think you'd read the collected Sources (the one's you'd put in the hypothetical collects_ids) then read collected_by, then GET /sources/<sourceId> for each of those. So possible. But quite a few requests. One each for the IDs you're starting from. Then one each for the IDs identified in collected_by.
There was a problem hiding this comment.
Ah, yes, I see that now - I suppose it might be useful to be able to query that way too
Co-authored-by: James Sandford <james.sandford@bbc.co.uk>
Details
Currently at the Source level there is no filtering on the
collected_byfield.When vendors are building systems which list content stored in TAMS then they are only looking for the Sources at the top of the content tree.
This PR is to add the ability to filter Sources (and Flows) to find the content which is not collected by another Source and therefore is the top level.
Jira Issue (if relevant)
Jira URL:
Related PRs
Where appropriate. Indicate order to be merged.
Submitter PR Checks
(tick as appropriate)
Reviewer PR Checks
(tick as appropriate)
Info on PRs
The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.