You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@roller.apache.org by Dave <sn...@gmail.com> on 2007/08/23 15:45:28 UTC

Proposal for 4.1: Tag Data API

I haven't written up a wiki page for this yet, but I'd like to get
some feedback if possible:

Tag Data API

Make tag statistics data available via a simple XML format so that
other applications can access our tag data.

New URIs proposed:
   /roller-services/tagdata - get tag data for entire site
   /roller-services/tagdata/weblogs/[handle] - get tag data for specific weblog

Request parameters supported by URIs:
   sort - either "alphabetical" or "popularity"

Tag data format (application/xml+tagdata) could be something like this:
   <tags>
      <tag name="bluenote" count="24" />
      <tag name="rocksteady" count="349" />
      <tag name="ska" count="349" />
      . . .
      <link rel="next"
href="http://localhost:8080/roller/roller-services/tagdata?page=2" />
   </tags>

As in Atom protocol, the <link> element is used to support next/previous paging.

Other Tag Data APIs

See also:
   http://www.flickr.com/services/api/flickr.tags.getHotList.html
   http://del.icio.us/help/api/tags


Tracking this as ROL-1545:
http://opensource.atlassian.com/projects/roller/browse/ROL-1545

Re: Proposal for 4.1: Tag Data API

Posted by Dave <sn...@gmail.com>.

On 8/23/07, Dave <sn...@gmail.com> wrote:
> Tag data format (application/xml+tagdata) could be something like this:
>    <tags>
>       <tag name="bluenote" count="24" />
>       <tag name="rocksteady" count="349" />
>       <tag name="ska" count="349" />
>       . . .
>       <link rel="next"
> href="http://localhost:8080/roller/roller-services/tagdata?page=2" />
>    </tags>


After I proposed the Tag Data API on the Roller list, I was chatting
with James Snell and he had a great suggestion. Instead of defining a
new format, just use an Atom Categories document with an extension
attribute for the count, like so:

<categories fixed="no" xmlns:tagdata="..." xmlns="...">
  <atom:category term="foo" tagdata:frequency="10" />
  <atom:category term="bar" tagdata:frequency="8" />
  <atom:link rel="next" href="http://host/roller-services/tagdata?page=2" />
</categories>

I think that's *much* better.

- Dave

Re: Proposal for 4.1: Tag Data API

Posted by Matt Raible <ma...@raibledesigns.com>.

That makes sense.

On 8/23/07, Dave <sn...@gmail.com> wrote:
> On 8/23/07, Matt Raible <ma...@raibledesigns.com> wrote:
> > This sounds good to me. For specific weblogs, why not do /tagdata/[handle]?
>
> Because someday I would like to provide user tags, i.e.:
>
>    /tagdata/users/[username]
>
> - Dave
>


-- 
http://raibledesigns.com

Re: Proposal for 4.1: Tag Data API

Posted by Dave <sn...@gmail.com>.

On 8/23/07, Matt Raible <ma...@raibledesigns.com> wrote:
> This sounds good to me. For specific weblogs, why not do /tagdata/[handle]?

Because someday I would like to provide user tags, i.e.:

   /tagdata/users/[username]

- Dave

Re: Proposal for 4.1: Tag Data API

Posted by Matt Raible <ma...@raibledesigns.com>.

This sounds good to me. For specific weblogs, why not do /tagdata/[handle]?

Matt

On 8/23/07, Dave <sn...@gmail.com> wrote:
> I haven't written up a wiki page for this yet, but I'd like to get
> some feedback if possible:
>
> Tag Data API
>
> Make tag statistics data available via a simple XML format so that
> other applications can access our tag data.
>
> New URIs proposed:
>    /roller-services/tagdata - get tag data for entire site
>    /roller-services/tagdata/weblogs/[handle] - get tag data for specific weblog
>
> Request parameters supported by URIs:
>    sort - either "alphabetical" or "popularity"
>
> Tag data format (application/xml+tagdata) could be something like this:
>    <tags>
>       <tag name="bluenote" count="24" />
>       <tag name="rocksteady" count="349" />
>       <tag name="ska" count="349" />
>       . . .
>       <link rel="next"
> href="http://localhost:8080/roller/roller-services/tagdata?page=2" />
>    </tags>
>
> As in Atom protocol, the <link> element is used to support next/previous paging.
>
> Other Tag Data APIs
>
> See also:
>    http://www.flickr.com/services/api/flickr.tags.getHotList.html
>    http://del.icio.us/help/api/tags
>
>
> Tracking this as ROL-1545:
> http://opensource.atlassian.com/projects/roller/browse/ROL-1545
>


-- 
http://raibledesigns.com