Documentation
¶
Overview ¶
Package miniflux implements the Miniflux adapter for the reader capability.
Index ¶
- func New() reader.Service
- func NewWithClient(client client) reader.Service
- type Adapter
- func (a *Adapter) CreateFeed(ctx context.Context, feedURL string) (*ability.Feed, error)
- func (a *Adapter) ListEntries(ctx context.Context, q *reader.EntryQuery) (*ability.ListResult[ability.Entry], error)
- func (a *Adapter) ListFeeds(ctx context.Context, q *reader.FeedQuery) (*ability.ListResult[ability.Feed], error)
- func (a *Adapter) MarkEntryRead(ctx context.Context, id int64) error
- func (a *Adapter) MarkEntryUnread(ctx context.Context, id int64) error
- func (*Adapter) StarEntry(ctx context.Context, _ int64) error
- func (*Adapter) UnstarEntry(ctx context.Context, _ int64) error
- type Webhook
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewWithClient ¶
Types ¶
type Adapter ¶
type Adapter struct {
// contains filtered or unexported fields
}
func (*Adapter) CreateFeed ¶
func (*Adapter) ListEntries ¶
func (a *Adapter) ListEntries(ctx context.Context, q *reader.EntryQuery) (*ability.ListResult[ability.Entry], error)
func (*Adapter) MarkEntryRead ¶
func (*Adapter) MarkEntryUnread ¶
type Webhook ¶
type Webhook struct {
// contains filtered or unexported fields
}
Webhook implements ability.WebhookConverter for Miniflux RSS reader webhooks. It validates HMAC-SHA256 signatures and converts Miniflux webhook payloads into DataEvent records for the pipeline engine.
func NewWebhook ¶
func NewWebhook() *Webhook
NewWebhook creates a Webhook that reads the HMAC secret from the miniflux provider config lazily at verification time.
func (*Webhook) Convert ¶
Convert transforms the raw Miniflux webhook body into one or more DataEvent records. new_entries produces a single batch event with all entries in the Data KV. save_entry produces a single event with the saved entry in the Data KV.
func (*Webhook) VerifySignature ¶
VerifySignature validates the HMAC-SHA256 signature from the X-Miniflux-Signature header. The secret is read from provider config at verification time via getSecret.
func (*Webhook) WebhookPath ¶
WebhookPath returns the URL path segment for Miniflux webhooks. The full URL is /webhook/provider/miniflux/events.
Source Files