[openstreetmap/openstreetmap-website] Supporting multiple API versions (#2353)

Simon Poole notifications at github.com
Wed Sep 4 12:21:48 UTC 2019

@gravitystorm you are essentially making an argument for versioning the representation too. Up to now the abstract underlying data representation has essentially been documented (if you so want) by the XML representation and has been in lock step with that. 

Now clearly we could change the representation in isolation, as your example  suggests, without changing the API nor the underlying abstract data model and this would clearly require changing the API version too, because without that you would not know that you are getting a non-backwards compatible XML doc. But the ITU lies in the direction of doing and supporting that kind of change, so I hope we are not venturing there.

But the other way around does not imply the same thing, for example all the changes that have been made to the API to date work just fine with 0.6 XML documents.  And for example it would be -very- surprising if implementing https://github.com/openstreetmap/openstreetmap-website/issues/2348 and jacking up the API version would suddenly result in output that is not parseable by tools (at least those that do proper validation of their input) that would in principle work just fine if the gratious change to the "representation version" hadn't been made.

You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20190904/3dd3ffb0/attachment-0001.html>

More information about the rails-dev mailing list