Fwd: Shared Records Annotation API Ready

1 view
Skip to first unread message

Cory Zue

unread,
Nov 7, 2007, 6:04:35 PM11/7/07
to shared-...@googlegroups.com, Martin Budden, Saq Imtiaz, Greg Wolff, Andreas Kollegger, Jonathan Jackson
Hi Everyone,

I wanted to let you know that the annotation API we've been discussing has been merged into svn and is ready for consumption.  The attached document, which contains minor revisions from the previous iteration, fully describes the API. 

For those wishing to test against or consume the API, test.sharedrecords.org is currently serving both the annotation api and the core api at the following URL's:

core (rest interface): http://test.sharedrecords.org:8080/records/
annotation api: http://test.sharedrecords.org:8080/annotations/

example access to the annotation API:
http://test.sharedrecords.org:8080/annotations/385c7c019544dbe75736223ffd7ee18b872f6b08
http://test.sharedrecords.org:8080/annotations/385c7c019544dbe75736223ffd7ee18b872f6b08/title1?mostRecentByTitle=false
http://test.sharedrecords.org:8080/annotations/385c7c019544dbe75736223ffd7ee18b872f6b08?title=title1|title2|title3&format=json&attributes=title|userid|contentType


For developers and/or those who wish to build their own servlets,  the annotation servlet is maintained as a separate project in the svn repository under servlet/AnnotationServlet/trunk.  Instructions on building and deploying servlets can be found here.

I've tried to ensure that the api is error-free through testing, but if and when errors come up please let me know.

thanks,
Cory

--
Cory L. Zue
Chief Technology Officer
Dimagi, Inc  |  One Kendall Square  |  Bldg. 400, 4th Floor  |  Cambridge, MA 02139
work: (617) 621 8595 x19  |  cell: (617) 416 0544
http://www.dimagi.com/

Cory Zue

unread,
Nov 7, 2007, 6:05:25 PM11/7/07
to shared-...@googlegroups.com, Martin Budden, Saq Imtiaz, Greg Wolff, Andreas Kollegger, Jonathan Jackson
Sorry, this attached document.

-Cory
Shared Records Annotation API to support filtering (version 2).doc

Martin Budden

unread,
Nov 8, 2007, 5:59:12 AM11/8/07
to Cory Zue, shared-...@googlegroups.com, Saq Imtiaz, Greg Wolff, Andreas Kollegger, Jonathan Jackson
Cory,

The document looks fine and has incorporated our previous discussion
about the form of the API. I have a few minor comments:

1) You state "The shared records annotation API will be a separate API
from the core REST API." I'm not entirely clear what you mean by "a
separate API" - perhaps you could clarify this a bit.

2) The document mixes tenses in a few places
i) "The shared records annotation API will be a separate API", should
be "is", not "will be"
ii) "The requests should take the following form:" should be "The
requests take the following form"
There are several other cases where "should" should be replaced by
"is" or "are".


On another issue, you might consider making the APIs self-documenting, so that

http://test.sharedrecords.org:8080/annotations/

returns a page with the API documentation, rather than an error
message. Mediawiki does this, see:

http://meta.wikimedia.org/w/api.php

As I mentioned I'm on holiday next week, an will be pretty busy at BT
the week after that, but I plan to write a tiddlywiki adaptor to use
the new API as soon as possible after that.

Martin

Cory Zue

unread,
Feb 5, 2008, 11:30:47 AM2/5/08
to l...@world.std.com, shared-...@googlegroups.com
Should have mentioned this earlier - the web server on test.sharedrecords.org - and as a result all the API's - have moved to port 80 (should no longer have to specify a port). 

It is not an svn server...  Were you looking for the shared records source?

-Cory

On 2/5/08, l...@world.std.com <l...@world.std.com> wrote:
Hi, Cory. Is test.sharedrecords.org:8080 an svn server? And is it
still alive, or has the api moved somewhere?

Thanks.

Cheers.



On Nov 7 2007, 6:04 pm, "Cory Zue" <c...@dimagi.com> wrote:
> Hi Everyone,
>
> I wanted to let you know that the annotation API we've been discussing has
> been merged into svn and is ready for consumption.  The attached document,
> which contains minor revisions from the previous iteration, fully describes
> the API.
>
> For those wishing to test against or consume the API,
> test.sharedrecords.orgis currently serving both the annotation api and

> the core api at the
> following URL's:
>
> core (rest interface):http://test.sharedrecords.org:8080/records/
> annotation api:http://test.sharedrecords.org:8080/annotations/
>

>
> For developers and/or those who wish to build their own servlets,  the
> annotation servlet is maintained as a separate project in the svn repository
> under servlet/AnnotationServlet/trunk.  Instructions on building and
> deploying servlets can be found

> .
>
> I've tried to ensure that the api is error-free through testing, but if and
> when errors come up please let me know.
>
> thanks,
> Cory
>
> --
> Cory L. Zue
> Chief Technology Officer
> Dimagi, Inc  |  One Kendall Square  |  Bldg. 400, 4th Floor  |  Cambridge,
> MA 02139
> work: (617) 621 8595 x19  |  cell: (617) 416 0544http://www.dimagi.com/
Reply all
Reply to author
Forward
0 new messages