Expand description
Serialized output types — the AI-facing API contract.
Field names here are a stable contract: agents depend on them. Optional fields are
serialized as null (never omitted) so the shape is predictable across every item.
The authoritative schema is produced from these structs via crate::output::schema_for
(schemars); the docs in the plan are only illustrative.
Structs§
- Discover
Output - Top-level result of
rss discover. - Discovered
Feed - A feed discovered on a website’s homepage.
- Enclosure
- A media attachment (podcast audio, image, etc.).
- Error
Obj - A structured, machine-readable error. Emitted to stdout under
--format jsonand always carried inFeedResult::error/FetchOutput::errors. - Feed
Result - Per-feed result.
- Fetch
Output - Top-level result of
rss fetch. - Item
- A single feed item / entry.
- Truncation
Info - Describes how a
FetchOutputwas bounded. A summary so an agent can tell at a glance that it is not seeing the full, untruncated result and how to adjust. - Warning
- A non-fatal data-quality note about a feed (the feed still parsed and produced items). Surfaces silent fallbacks an agent should know about — e.g. lower-fidelity content extraction, or items it cannot order by time.
Enums§
- Content
Format - The format of
Item::content. - Feed
Status - Outcome of fetching a single feed.
- IdSource
- Which feed field the stable
Item::idwas derived from.
Constants§
- SCHEMA_
VERSION - Output schema version. Bump on any breaking change to these structs.