#1552 closed defect (fixed)

web-API: replace ?mutable-type with ?format={chk,sdmf,mdmf}

Reported by: davidsarah Owned by: kevan
Priority: major Milestone: 1.9.0
Component: code-frontend-web Version: 1.9.0a2
Keywords: weapi mutable mdmf forward-compatibility review-needed Cc:
Launchpad Bug:

Description

We agreed (on IRC) to change the ?mutable-type= query parameter to a ?format= parameter with options chk, sdmf, and mdmf. For compatibility, the ?mutable=true flag would still be accepted and would mean the same as ?format=sdmf (at least for now). The values should be case-insensitive.

This way, if we add a new immutable format in future, it won't require a new query parameter. This also makes the implementation of #1547 easier.

Attachments (2)

test-1552.darcs.patch (57.9 KB) - added by davidsarah at 2011-10-02T04:10:59Z.
Tests for ref #1552
add-format-docs.darcs.patch (11.9 KB) - added by kevan at 2011-10-10T04:07:58Z.
add documentation for the format argument to webapi.rst

Download all attachments as: .zip

Change History (6)

comment:1 Changed at 2011-10-02T01:08:08Z by davidsarah

  • Owner set to kevan

comment:2 Changed at 2011-10-02T01:34:48Z by davidsarah

I'm writing tests for this, so Kevan, you only need to do the docs and implementation.

Note that there's a "mutable-type" field in the returned JSON that should also be changed to "format", and should have the value "chk" for immutable uploads.

Changed at 2011-10-02T04:10:59Z by davidsarah

Tests for ref #1552

comment:3 Changed at 2011-10-02T14:02:45Z by davidsarah

  • Keywords review-needed added

Changed at 2011-10-10T04:07:58Z by kevan

add documentation for the format argument to webapi.rst

comment:4 Changed at 2011-10-13T16:40:51Z by warner

  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.