#118 closed enhancement (fixed)

refactor webapi

Reported by: zooko Owned by: zooko
Priority: major Milestone: 0.6.0
Component: code-frontend-web Version: 0.5.0
Keywords: Cc:
Launchpad Bug:

Description

I would like to change the web API in some of the following ways. I'm not absolutely sure that this is exactly the way to do it, or that there aren't other changes that will suggest themselves as the v0.5 version gets more use.

The following ideas were already posted to the mailing list in this message:

http://allmydata.org/pipermail/tahoe-dev/2007-August/000101.html

My proposed new webapi is attached as a text file to this ticket.

  • The big change: unify discussion of name-based and uri-based commands, and expect the reader to understand both at once, and refactor the document to have six use-case-oriented sections.
  • Include a read-write uri (if available) in the metadata instead of by a separate API call.
  • Signal mutability by the presence of a RW URI instead of by a separate "mutable" bool.
  • add ?overwrite={True,False} for the name-adding commands

See also: a couple of other tickets about changes to webAPI:

#89, #98, #102

Attachments (2)

webapi-new.txt (17.4 KB) - added by zooko at 2007-08-20T19:51:18Z.
webapi-new.txt
webapi.warner1.diff (6.5 KB) - added by warner at 2007-08-23T19:41:42Z.
my proposed changes to the new version

Download all attachments as: .zip

Change History (3)

Changed at 2007-08-20T19:51:18Z by zooko

webapi-new.txt

Changed at 2007-08-23T19:41:42Z by warner

my proposed changes to the new version

comment:1 Changed at 2007-09-09T14:27:07Z by zooko

  • Resolution set to fixed
  • Status changed from new to closed

This was done for v0.5.1 release.

Note: See TracTickets for help on using tickets.