Jaculabilis/intake
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README for tt{l,d,s} fields

Browse Source
This commit is contained in:
Tim Van Baak 2025-02-05 12:49:37 -08:00
parent 1ee91c1abe
commit fee7c9225b
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -13,7 +13,7 @@ Parity with existing Python version
* fetch sources * fetch sources
* [x] create and delete items * [x] create and delete items
* [x] update existing items * [x] update existing items
* [ ] support item TTL and TTD * [x] support item TTL and TTD
* [x] on_create triggers * [x] on_create triggers
* [ ] on_delete triggers * [ ] on_delete triggers
* [x] dry-run * [x] dry-run
@ -94,6 +94,9 @@ Any unspecified field is equivalent to the empty string, object, or 0, depending
| `body` | Optional | Body text of the item as raw HTML. This will be displayed in the item without further processing! Consider your sources' threat models against injection attacks. | `body` | Optional | Body text of the item as raw HTML. This will be displayed in the item without further processing! Consider your sources' threat models against injection attacks.
| `link` | Optional | A hyperlink associated with the item. | `link` | Optional | A hyperlink associated with the item.
| `time` | Optional | A Unix timestamp associated with the item, not necessarily when the item was created. Items sort by `time` when it is defined and fall back to `created`. Displayed in the item footer. | `time` | Optional | A Unix timestamp associated with the item, not necessarily when the item was created. Items sort by `time` when it is defined and fall back to `created`. Displayed in the item footer.
| `ttl` | Optional | The time-to-live of the item. An item with `ttl` defined is not deleted by feed updates as long as `created + ttl` is in the future, even if it is inactive.
| `ttd` | Optional | The time-to-die of the item. An item with `ttd` defined is deleted by feed updates if `created + ttd` is in the past, even if it is active.
| `tts` | Optional | The time-to-show of the item. An item with `tts` defined is hidden from feeds before the time `created + tts`.
| `action` | Optional | A JSON object with keys for all supported actions. No schema is imposed on the values. | `action` | Optional | A JSON object with keys for all supported actions. No schema is imposed on the values.
Existing items are updated with new values when a fetch or action produces them, with some exceptions: Existing items are updated with new values when a fetch or action produces them, with some exceptions: