Skip to content

Latest commit

 

History

History
127 lines (69 loc) · 4.7 KB

rssprovider.md

File metadata and controls

127 lines (69 loc) · 4.7 KB

RSS provider Schema

https://example.com/autoDownloader/schemas/providers/RssProvider.json

Extracts links from an RSS feed. Can filter which RSS items to take into account using regular expressions on the title

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Allowed none RssProvider.json

RSS provider Type

object (RSS provider)

RSS provider Properties

Property Type Required Nullable Defined by
type string Required cannot be null RSS provider
url string Required cannot be null RSS provider
namespaces object Optional cannot be null RSS provider
xpaths object Required cannot be null RSS provider
patterns array Optional cannot be null RSS provider

type

type

  • is required

  • Type: string

  • cannot be null

  • defined in: RSS provider

type Type

string

type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"RssProvider"

url

URL of the RSS feed. Should point to a standard RSS xml document

url

  • is required

  • Type: string

  • cannot be null

  • defined in: RSS provider

url Type

string

url Constraints

unknown format: the value of this string must follow the format: url

namespaces

mapping for the namespaces found in the RSS xml document. These are required for the XPath expression to work properly in case the elements mentioned in the expression are under a namespace

namespaces

namespaces Type

object (Details)

xpaths

XPath expressions used to identify, filter and extract the url from the RSS feed

xpaths

xpaths Type

object (Details)

patterns

list of regular expressions to match against the title of each RSS item. The corresponding URL will be passed to the downloader if any of these patterns match

patterns

  • is optional

  • Type: string[]

  • cannot be null

  • defined in: RSS provider

patterns Type

string[]