Application Programming Interface (API)

Comments

Contents

Overview

 

Extensions

Comments

 

Endpoints

Books

Authors

Categories

Lists

 

Related Links

OPDS

Atom Format

Atom Publishing Protocol

Atom Threading Extensions

Comments are not part of the OPDS specifications.

For this reason, Feedbooks created an OPDS extension to list and post comments using Atom, AtomPub and a Link Relation registered at the Link Relation Registry.

Feedbooks uses the "replies" relation in Atom to identify comments, as defined in the Link Relation Registry: Identifies a resource that is a reply to the context of the link.

Such links can be found in either entries (for books) or feeds (for authors or lists).

Listing comments

Comments are listed as basic Atom entries. In atom:content the full comment is listed, and in atom:author you'll find the username of the author.

Posting a comment

In our feed for comments, you'll notice an app:collection element describing an AtomPub collection where you can POST an Atom entry.

The only element required in your Atom entry is atom:content, the rest will be added by the server when you POST it.

Authentication is required to post a comment.

An example