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

Closed
opened 2011-10-02 00:42:22 +00:00 by davidsarah · 4 comments
davidsarah commented 2011-10-02 00:42:22 +00:00
Owner

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.

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.
tahoe-lafs added the
code-frontend-web
major
defect
1.9.0a2
labels 2011-10-02 00:42:22 +00:00
tahoe-lafs added this to the 1.9.0 milestone 2011-10-02 00:42:22 +00:00
davidsarah commented 2011-10-02 01:34:48 +00:00
Author
Owner

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.

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.
davidsarah commented 2011-10-02 04:10:59 +00:00
Author
Owner

Attachment test-1552.darcs.patch (59293 bytes) added

Tests for ref #1552

**Attachment** test-1552.darcs.patch (59293 bytes) added Tests for ref #1552
kevan commented 2011-10-10 04:07:58 +00:00
Author
Owner

Attachment add-format-docs.darcs.patch (12171 bytes) added

add documentation for the format argument to webapi.rst

**Attachment** add-format-docs.darcs.patch (12171 bytes) added add documentation for the format argument to webapi.rst

fixed by changeset:bd642739cb5b4771 and changeset:01b00dc7dca9108f

fixed by changeset:bd642739cb5b4771 and changeset:01b00dc7dca9108f
warner added the
fixed
label 2011-10-13 16:40:51 +00:00
Sign in to join this conversation.
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Reference: tahoe-lafs/trac-2024-07-25#1552
No description provided.