We will discuss options for REST API response format versioning and -negotiation in Wednesday's RFC meeting:
Topic: https://phabricator.wikimedia.org/T124365 Time: Wednesday 22:00 UTC (2pm PST) Location: #wikimedia-office IRC channel
This RFC will then enter its one-week Final Comment Period, after which the Architecture Committee will decide based on the discussion.
I'm looking forward to your input on the task or IRC.
Gabriel
On Thu, Jan 21, 2016 at 4:29 PM, Gabriel Wicke gwicke@wikimedia.org wrote:
Hi,
we are considering a policy for REST API end point result format versioning and negotiation. The background and considerations are spelled out in a task and mw.org page:
https://phabricator.wikimedia.org/T124365 https://www.mediawiki.org/wiki/Talk:API_versioning
Based on the discussion so far, have come up with the following candidate solution:
- Clearly advise clients to explicitly request the expected mime type
with an Accept header. Support older mime types (with on-the-fly transformations) until usage has fallen below a very low percentage, with an explicit sunset announcement.
- Always return the latest content type if no explicit Accept header
was specified.
We are interested in hearing your thoughts on this.
Once we have reached rough consensus on the way forward, we intend to apply the newly minted policy to an evolution of the Parsoid HTML format, which will move the data-mw attribute to a separate metadata blob.
Gabriel Wicke