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
returns a page with the API documentation, rather than an error
message. Mediawiki does this, see:
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.
Hi, Cory. Is test.sharedrecords.org:8080 an svn server? And is it
still alive, or has the api moved somewhere?
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
> example access to the annotation API:http://test.sharedrecords.org:8080/annotations/385c7c019544dbe7573622...
> 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.
> 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/