This repository uses (M)ADR documents to propose significant changes, facilitate discussions and decision making, and to store a record of options that were considered. The following is an index of currently available ADRs. For more information on how we use ADRs, see here.
| ADR Number | Title |
|---|---|
| 0000 | Use Markdown ADRs to record design decisions |
| 0001 | Expand Created-by and Modified-by Metadata |
| 0002 | Add Sources as objects in the API |
| 0003 | Created and Modified Timestamps should be managed internally |
| 0004 | Deletion of Content and IDs |
| 0004a* | Flow and Source References |
| 0005 | Flow Read-Write Permissions |
| 0006 | Flow Update Status |
| 0007 | Use Timerange in Flow Segments |
| 0008 | Move Flow Parameters into a sub-property |
| 0009 | Allow Segments to Overlap |
| 0010 | Add pagination to Flow/Source listing endpoints |
| 0011 | Random Storage Object IDs |
| 0012 | Add collections to flow and source metadata schemas |
| 0013 | Timeline exposed by Flows |
| 0014 | Add an event stream to the TAMS API |
| 0015 | Make FlowSegment get_url expectations clearer |
| 0016 | Add Object Checksums and Filesizes |
| 0017 | Defining the Container Mapping to a Flow |
| 0018 | Restrict direct Source modification |
| 0019 | Rename modified_by properties in Source and Flow schemas to updated_by |
| 0020 | Improving the signalling of the supported API version in implementations |
* Note: ADR 0004a was the unintended result of a number clash in the early development of TAMS which wasn't caught before publication
Application notes are informatative documents describing the recommended usage of the API. For more information on how we use application notes, see here.
| Application Note Number | Title |
|---|---|
| 0001 | Practical Application of the TAMS Content Model |
| 0002 | Timing in MPEG-TS |
| 0003 | Tags, how to use them, and how we manage them |
| 0004 | When TAMS is a good fit for non-media data. And when it’s not |
| 0005 | Media objects should be independently decodable. Here's why |
| 0006 | Containers and Mappings |
| 0007 | Populating Source Metadata |
| 0008 | Timestamps in TAMS |
| 0009 | Storage label format specification |
| 0010 | Long-running Sources and Flows |