Commit Graph

60 Commits

Author SHA1 Message Date
Brian Warner
01469433ef docs: update webapi.txt with write-coordination issues, add TODO note to recovery section of mutable.txt 2008-06-02 23:03:21 -07:00
Brian Warner
3ac4a734e5 web t=json: add 'mutable' key to the information dict 2008-05-20 15:40:49 -07:00
Brian Warner
151f69d9b5 webapi.txt: overhaul documentation. API changes are as follows:
* download/upload localdir=/localfile= has been removed. This sort of ambient
   authority was unsafe to expose over the web (CSRF), and at some point
   soon we'll have 'cp -r' in the CLI to replace it.
 * GET save=filename -> GET filename=filename&save=true
 * GET t=download removed
 * side-effect causing operations now use POST where appropriate, not PUT
 * to create multiple directories, either use
   * POST /uri/DIRCAP/parent?t=mkdir&name=child  (more form/browser oriented)
   * POST /uri/DIRCAP/parent/child?t=mkdir (more machine oriented)
   The t=mkdir-p form is still accepted, but not preferred (since it leaks
   the child name queryarg into the logs)
 * use PUT /uri/MUTABLEFILECAP or PUT /uri/DIRCAP/child (on a mutable file) to
   replace its contents, or POST /same?t=upload from forms
 * response bodies and codes are better specified than before
2008-05-19 12:47:46 -07:00
Brian Warner
fabdc28c06 deep-stats: add file-size histogram 2008-05-08 16:19:42 -07:00
Brian Warner
6c00a70dbc dirnode: add a deep_stats(), like deep-size but with more information. webish adds t=deeps-size too. 2008-05-08 13:21:14 -07:00
Zooko O'Whielacronx
60eb3505f5 docs: tiny update to webapi.txt
I'm actually committing this just to test our patch management infrastructure.
2008-04-17 21:09:12 -07:00
Zooko O'Whielacronx
9b4a213824 docs: tiny change in webapi.txt
(I'm actually committing this patch only in order to test our patch management infrastructure.)
2008-04-17 21:00:51 -07:00
Zooko O'Whielacronx
3d4a339857 docs: merge conflicts between the patch to document "127.0.0.1" instead of "localhost" and some other patches (precisely which, I don't know) 2008-04-17 20:57:41 -07:00
Zooko O'Whielacronx
7b2ca46b35 docs: use "127.0.0.1" instead of "localhost"
Unfortunately there are occasionally configurations in the real world where "localhost" does not resolve to 127.0.0.1, and if a user has such a configuration then using 'localhost' could lead to an authority leak.
2008-04-17 20:45:34 -07:00
Brian Warner
9b3a32d0b3 add GET /uri/URI/?t=deep-size, to compute the total size of immutable files reachable from a given directory 2008-03-27 11:33:42 -07:00
Zooko O'Whielacronx
5cdc678d24 docs: fix example JSON in webapi.txt to be legal JSON. ;-) 2008-02-29 18:39:25 -07:00
Zooko O'Whielacronx
1934ae26f9 doc: change example filename extension back because it is more recognizable and because I love Brian 2008-02-27 14:54:05 -07:00
Zooko O'Whielacronx
0097d662c7 docs: tweak wording per kpreid and tweak example filename extension per me 2008-02-27 14:41:57 -07:00
Zooko O'Whielacronx
fed427b087 docs: clarify which webport value is the default 2008-02-27 11:10:03 -07:00
Brian Warner
7927495cbe unicode handling: declare dirnodes to contain unicode child names, update webish to match 2008-02-14 15:45:56 -07:00
Brian Warner
a70fba4ef1 webish: add edge metadata to t=json output, including timestamps 2008-02-11 19:14:10 -07:00
Brian Warner
7dcb4ee62b webapi.txt: document POST /uri?t=mkdir 2008-02-07 20:10:28 -07:00
Brian Warner
6e0d3059a3 webish: add when_done= to POST /uri?t=upload . I did not add a 'recent uploads' section to the welcome page, but I think the new upload-results page provides the desired data 2008-02-06 02:38:16 -07:00
Brian Warner
1e4504463c webish: make POST /uri?t=upload deposit you on an 'Upload Results' page 2008-02-05 23:01:37 -07:00
Brian Warner
23c2c8d660 webish: add PUT /uri?mutable=true 2008-02-05 22:18:02 -07:00
Brian Warner
e5dc9a8486 webish: add POST /uri?t=upload&mutable=true 2008-02-05 22:10:22 -07:00
Brian Warner
6afe50e2aa webish: add upload/view-uri forms (not associated with any particular directory) to the welcome page. Document POST /uri?t=upload . 2008-02-05 21:44:40 -07:00
nejucomo
7caec120b3 docs: webapi: Add concise shorthand for options, input, output, and statuses to the operation descriptions...
I'm not convinced if this is the best way to do this, but I find it
handy to have a conscise "quick reference" for the webapi operations
which summarize all related I/O.

Another possibility is to reject this patch, but create a separate
"webapi_quickref.html" with a concise table.
2008-01-30 01:27:42 -07:00
Brian Warner
8b9f86fb17 remove the slash-to-bang conversion from CLI tools and webapi.txt 2007-12-17 20:22:26 -07:00
Brian Warner
785f21b9bf test_web.py: add coverage for POST t=check 2007-12-04 23:49:38 -07:00
Brian Warner
56e02b274b webish: add POST t=mutable, make it replace files in-place, add t=overwrite 2007-12-04 23:42:54 -07:00
Brian Warner
9de9346a66 docs/webapi.txt: document the POST t=upload&mutable=on command used to create mutable files 2007-11-09 04:05:07 -07:00
Zooko O'Whielacronx
0455c13082 webapi.txt: update webapi.txt to reflect the security fix from #98 2007-10-15 12:29:02 -07:00
Brian Warner
c35ed6ff11 docs/webapi.txt: mention that we default to a --webport of 8123 2007-10-11 13:19:11 -07:00
Brian Warner
6bbc5fcbb4 docs: change our default HTTP port to 8123 2007-10-11 13:17:33 -07:00
Brian Warner
2da65f118c webapi.txt: reinstate documentation of the unpleasant URI-escaping needed for
slashes in dirnode URIs, to be resolved some day by #102.
2007-10-11 06:58:08 -07:00
Zooko O'Whielacronx
9b4a0ffa30 webapi.txt: minor edits 2007-08-23 13:09:44 -07:00
Zooko O'Whielacronx
75b10954e4 webapi.txt edits (thanks to Brian Warner) 2007-08-23 13:06:06 -07:00
Zooko O'Whielacronx
2b77a70920 new improved webapi.txt
As per ticket #118, this refactors the explanation of URIs and paths and changes the JSON metadata schema.

http://allmydata.org/trac/tahoe/ticket/118
2007-08-23 13:03:26 -07:00
Zooko O'Whielacronx
6c38118c36 webapi.txt: s/dirnodes/directories/ 2007-08-16 15:53:53 -07:00
Brian Warner
944ad6508b webapi.txt: specify replace= behavior on all PUT and POST commands 2007-08-15 19:31:49 -07:00
Brian Warner
31bfb3950a webapi.txt: clear up underspecified items, replace 'webpassword' paragraph
with a section about our expected plans for #98, add more introductory text
to the sections on manipulate-file vs manipulate-directory.
2007-08-15 19:04:47 -07:00
Zooko O'Whielacronx
4f2244bfdd webapi.txt: shorter and hopefully clearer description of names vs. identifiers
Brian (and anyone who has an interest in the API and documentation): please review.
2007-08-15 12:28:04 -07:00
Brian Warner
b4a0effe30 webapi.txt: separate out debug/test commands, indicate that localfile=/localdir= requires special activation 2007-08-10 18:20:22 -07:00
Brian Warner
54b6900526 webapi.txt: minor clarifications and examples 2007-08-10 15:52:27 -07:00
Zooko O'Whielacronx
c0c6417e95 webapi.txt: put back the manifest feature
So that we can compare versions of webapi.txt with and without this documentation, side by side.
2007-08-10 12:58:33 -07:00
Zooko O'Whielacronx
ba2e9aa4cb webapi.txt: put back the localfile feature
So that we can compare versions webapi.txt with and without this documentation side by side.
2007-08-10 12:52:37 -07:00
Zooko O'Whielacronx
193f603e74 webapi.txt: add URI-based GET variants 2007-08-10 12:33:29 -07:00
Zooko O'Whielacronx
89d2e1ac57 webapi.txt: some editing, and remove the localfile feature and the manifest feature
My motivation to remove these features is as per:

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

However, I haven't heard back from Brian yet, so I'm actually going to put them back in the next patch so that I can compare the two versions of webapi.txt side by side.
2007-08-10 12:24:13 -07:00
Zooko O'Whielacronx
887240e7a3 webapi.txt: further refactoring and add a section explaining TOCTTOU bugs and how to avoid them by using URIs 2007-08-10 12:04:30 -07:00
Zooko O'Whielacronx
e68a0e07de webapi.txt: further refactoring and editing to clarify the fact that you don't know whether a thing is a file or a directory before you fetch it 2007-08-10 10:19:27 -07:00
Zooko O'Whielacronx
8b0807812b webapi.txt: add "?t=file" flag and reorganize doc to discourage people from thinking that they know before hand the file-or-dir type of the thing that they are naming 2007-08-10 09:43:52 -07:00
Brian Warner
1bb44df8ba webapi.txt: update rfc reference 2007-08-09 11:24:35 -07:00
Brian Warner
f207f4a199 webish.py: disallow slashes in POSTed filenames. Closes #75. 2007-07-16 11:53:12 -07:00
robk-org
d65d02fa58 add a 'rename' button to the webish dir view
alongside the 'del' button is now presented a 'rename' button, which takes
the user to a new page, the 't=rename-form' page, which asks ther user for
the new name of the child and ultimately submits a POST request to the dir
for 't=rename' to perform the actual rename i.e. an attach followed by a
delete of children.
2007-07-12 16:53:54 -07:00