[OSM-dev] API 0.5 is on the way

Tom Hughes tom at compton.nu
Fri Sep 14 01:12:07 BST 2007


In message <20070913233255.GA11464 at lochewe.mathy.remote.org>
          Frederik Ramm <frederik at remote.org> wrote:

> I agree the 0.4 specification looked a bit headstrong by concentrating
> on which HTTP request type is used for something, and by trying to be
> very precise. In a way, the 0.4 spec was a real *protocol* spec as the
> page name suggested, while what people (understandably) want seems to
> be more of an API reference.

Well half the problem is that it didn't stick to specifying
the OSM protocol but went off on tangents trying to specify
the HTTP protocol and even bits of TCP/IP as well it seemed.

It should be sufficient to point at the HTTP RFC and then
describe the OSM protocol.

It was also badly ordered (as you seem to have noticed) and
grouped things by request method instead of object type which
seems to make more sense to me.

> I have re-structured things a bit and tried to make the whole thing a
> bit more readable, at the expense of a little precision here and
> there. I plan to add more real-world examples for the responses but I
> think they might best be placed on an extra page with links in
> between, in order not to disturb the reading flow too much:
> 
> http://wiki.openstreetmap.org/index.php/OSM_Protocol_Version_0.5
> 
> Let me know what you think about the structure. The plan is to more or
> less remove the first two chapters ("OSM Protocol Version 0.5
> prototype" and "Development Status") once 0.5 is in production, so
> that what is now chapter 3 is then the whole article.

I was just looking at it, and it looks much better.

Tom

-- 
Tom Hughes (tom at compton.nu)
http://www.compton.nu/




More information about the dev mailing list