Proposal Atom Protocol Comment Support

Abstract

Make it possible for an AtomPub client application to create, retrieve update and delete comments for each weblog entries.

Requirements

• CRUD on weblog entry comments
• Build on the Atom Threading Extension, hereinafter referer to as ATE

Issues

• What about entries that do not allow comments or limit time that they are allowed

Design

New comment collection

Currently, these URIs are supported for entries collections:

/roller-services/app/[weblog-handle>/entries
Entry collection for a blog
 
/roller-services/app/[weblog-handle]/entries/[offset]
Entry collection for a blog, with offset

/roller-services/app/[weblog-handle]/entry/[id]
Individual entry (i.e. edit URI)

We will add these URIs for comment collections:

/roller-services/app/[weblog-handle]/entry/[id]/comments
Comments collection for entry with id

/roller-services/app/[weblog-handle]/entry/[id]/comments/offset
Comments collection for entry with id

/roller-services/app/[weblog-handle]/entry/[id]/comment/[id]
Individual comment

Entries link relation 'replies' to indicate comment collection

We will use the techniques defined in the ATE for indicating entry to comment relationships. Each entry will include a <link> with relation 'replies' that points to the entry's comment collection.

<entry> <!-- representing a weblog entry -->
   ...
   <link rel="replies" type="application/atom+xml"
      href="http://examples.com/roller/roller-services/app/myblog/entry/454/comments" />
</entry>

Comments will use <thr:in-reply-to> element to indicate entry

We'll use the ATE's <thr:in-reply-to> element in each comment to point back the the entry which the comment is in-reply-to.

<entry> <!-- representing a comment-->
   ...
   <thr:in-reply-to rel="replies" type="application/atom+xml"
      href="http://examples.com/roller/roller-services/app/myblog/entry/454" />
</entry>

Comments

Please comment on the Roller dev mailing list.