Skip to content

Commit

Permalink
Merge pull request #244 from leonghui/json-specs-update
Browse files Browse the repository at this point in the history 
Update documentation for JSON feed
  • Loading branch information
@alexdebril
alexdebril authored Nov 27, 2019
2 parents e0e5234 + d517b85 commit 718077c
Showing 1 changed file with 48 additions and 42 deletions.
90 changes: 48 additions & 42 deletions doc/specifications-support.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,58 @@

This document explains which attributes are supported by feed-io and how to access them

## top level document : feed (atom) / channel (rss)
## top level document : feed (atom) / channel (rss) / top-level (json)

interface : FeedInterface

| atom | rss | getter | setter |
| ----------- | ----------------------- | --------------- | --------------- |
| title | title | getTitle | setTitle |
| link | link | getLink | setLink |
| updated | pubDate / lastBuildDate | getLastModified | setLastModified |
| id | N/A | getPublicId | setPublicId |
| N/A | description | getDescription | setDescription |
| category | category | getCategories | addCategory |
| author | author | getAuthor | setAuthor |
| contributor | N/A | not supported | not supported |
| logo | image | getLogo | setLogo |
| rights | copyright | not supported | not supported |
| subtitle | N/A | not supported | not supported |
| lang | language | getLanguage | setLanguage |
| base | N/A | not supported | not supported |
| generator | generator | not supported | not supported |
| N/A | managingEditor | not supported | not supported |
| N/A | webMaster | not supported | not supported |
| N/A | docs | not supported | not supported |
| N/A | cloud | not supported | not supported |
| N/A | ttl | not supported | not supported |
| N/A | rating | not supported | not supported |
| N/A | textInput | not supported | not supported |
| N/A | skipdays | not supported | not supported |
| N/A | skipHours | not supported | not supported |
| atom | rss | json | getter | setter |
| --------------- | ----------------------- | ------------- | --------------- | --------------- |
| title | title | title | getTitle | setTitle |
| link | link | home_page_url | getLink | setLink |
| link (rel=self) | N/A | feed_url | getLink | setLink |
| updated | pubDate / lastBuildDate | N/A | getLastModified | setLastModified |
| id | N/A | N/A | getPublicId | setPublicId |
| N/A | description | description | getDescription | setDescription |
| category | category | N/A | getCategories | addCategory |
| author | author | author (wip) | getAuthor | setAuthor |
| contributor | N/A | N/A | not supported | not supported |
| logo | image | icon | getLogo | setLogo |
| rights | copyright | N/A | not supported | not supported |
| subtitle | N/A | N/A | not supported | not supported |
| lang | language | N/A | getLanguage | setLanguage |
| base | N/A | N/A | not supported | not supported |
| generator | generator | N/A | not supported | not supported |
| N/A | managingEditor | N/A | not supported | not supported |
| N/A | webMaster | N/A | not supported | not supported |
| N/A | docs | N/A | not supported | not supported |
| N/A | cloud | hubs | not supported | not supported |
| N/A | ttl | N/A | not supported | not supported |
| N/A | rating | N/A | not supported | not supported |
| N/A | textInput | N/A | not supported | not supported |
| N/A | skipdays | N/A | not supported | not supported |
| N/A | skipHours | N/A | not supported | not supported |
| N/A | N/A | expired | not supported | not supported |

## entry (atom) / item (rss)
## entry (atom) / item (rss) / item (json)

Interface : ItemInterface

| atom | rss | getter | setter |
| ------------------- | ----------- | --------------- | --------------- |
| title | title | getTitle | setTitle |
| link | link | getLink | setLink |
| link | enclosure | getMedias | addMedia |
| updated / published | pubDate | getLastModified | setLastModified |
| id | guid | getPublicId | setPublicId |
| content | description | getDescription | setDescription |
| summary | N/A | not supported | not supported |
| source | source | not supported | not supported |
| category | category | getCategories | addCategory |
| author | N/A | getAuthor | setAuthor |
| contributor | N/A | not supported | not supported |
| N/A | comments | not supported | not supported |
| rights | N/A | not supported | not supported |
| atom | rss | json | getter | setter |
| ------------------- | ----------- | --------------------------- | --------------- | --------------- |
| title | title | title | getTitle | setTitle |
| link | link | url | getLink | setLink |
| link | enclosure | image (get only) | getMedias | addMedia |
| updated / published | pubDate | date_published | getLastModified | setLastModified |
| id | guid | id | getPublicId | setPublicId |
| content | description | content_html / content_text | getDescription | setDescription |
| summary | N/A | summary | not supported | not supported |
| source | source | N/A | not supported | not supported |
| category | category | tags (wip) | getCategories | addCategory |
| author | N/A | author | getAuthor | setAuthor |
| contributor | N/A | N/A | not supported | not supported |
| N/A | comments | N/A | not supported | not supported |
| rights | N/A | N/A | not supported | not supported |
| N/A | N/A | external_url | not supported | not supported |
| N/A | N/A | banner_image | not supported | not supported |
| N/A | N/A | attachments | not supported | not supported |
| N/A | N/A | date_modified | not supported | not supported |

0 comments on commit 718077c

Please sign in to comment.