ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-03-21 19:25:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/frontends/webapi.rst: cosmetics.

Browse Source 
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
This commit is contained in:
Daira Hopwood 2013-04-05 06:11:27 +01:00
parent 35f37cc5b8
commit b1064d456b
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/frontends/webapi.rst
View File

@ -14,21 +14,21 @@ The Tahoe REST-ful Web API
1. `Reading a file`_
2. `Writing/Uploading a File`_
3. `Creating a New Directory`_
4. `Getting Information About A File Or Directory (as JSON)`_
4. `Getting Information About a File Or Directory (as JSON)`_
5. `Attaching an Existing File or Directory by its read- or write-cap`_
6. `Adding Multiple Files or Directories to a Parent Directory at Once`_
7. `Unlinking a File or Directory`_
6. `Browser Operations: Human-Oriented Interfaces`_
1. `Viewing A Directory (as HTML)`_
1. `Viewing a Directory (as HTML)`_
2. `Viewing/Downloading a File`_
3. `Getting Information About A File Or Directory (as HTML)`_
3. `Getting Information About a File Or Directory (as HTML)`_
4. `Creating a Directory`_
5. `Uploading a File`_
6. `Attaching An Existing File Or Directory (by URI)`_
7. `Unlinking A Child`_
8. `Renaming A Child`_
6. `Attaching an Existing File Or Directory (by URI)`_
7. `Unlinking a Child`_
8. `Renaming a Child`_
9. `Relinking a Child`_
10. `Other Utilities`_
11. `Debugging and Testing Features`_
@ -337,7 +337,7 @@ that use HTTP to communicate with a Tahoe node. A later section describes
operations that are intended for web browsers.
Reading A File
Reading a File
--------------
``GET /uri/$FILECAP``
@ -353,7 +353,7 @@ Reading A File
purpose.
Writing/Uploading A File
Writing/Uploading a File
------------------------
``PUT /uri/$FILECAP``
@ -416,7 +416,7 @@ Writing/Uploading A File
interprets those arguments in the same way as the linked forms of PUT
described immediately above.
Creating A New Directory
Creating a New Directory
------------------------
``POST /uri?t=mkdir``
@ -661,7 +661,7 @@ Creating A New Directory
or already has a child named NAME.
Getting Information About A File Or Directory (as JSON)
Getting Information About a File Or Directory (as JSON)
-------------------------------------------------------
``GET /uri/$FILECAP?t=json``
@ -954,7 +954,7 @@ Adding Multiple Files or Directories to a Parent Directory at Once
existing "tahoe" metadata is preserved. The metadata["tahoe"] value is
reserved for metadata generated by the tahoe node itself. The only two keys
currently placed here are "linkcrtime" and "linkmotime". For details, see
the section above entitled "Get Information About A File Or Directory (as
the section above entitled "Getting Information About a File Or Directory (as
JSON)", in the "About the metadata" subsection.
Note that this command was introduced with the name "set_children", which
@ -1010,7 +1010,7 @@ specified by using <input type="hidden"> elements. For clarity, the
descriptions below display the most significant arguments as URL query args.
Viewing A Directory (as HTML)
Viewing a Directory (as HTML)
-----------------------------
``GET /uri/$DIRCAP/[SUBDIRS../]``
@ -1066,7 +1066,7 @@ Viewing/Downloading a File
URLs may also use /file/$FILECAP/FILENAME as a synonym for
/named/$FILECAP/FILENAME.
Getting Information About A File Or Directory (as HTML)
Getting Information About a File Or Directory (as HTML)
-------------------------------------------------------
``GET /uri/$FILECAP?t=info``
@ -1122,7 +1122,7 @@ Creating a Directory
This accepts a format= argument in the query string. Refer to the
documentation of POST /uri/$DIRCAP/[SUBDIRS../]?t=mkdir&name=CHILDNAME in
`Creating A New Directory`_ for information on the behavior of the format=
`Creating a New Directory`_ for information on the behavior of the format=
argument.
If a "when_done=URL" argument is provided, the HTTP response will cause the
@ -1162,7 +1162,7 @@ Uploading a File
operation took, etc.
This accepts format= and mutable=true query string arguments. Refer to
`Writing/Uploading A File`_ for information on the behavior of format= and
`Writing/Uploading a File`_ for information on the behavior of format= and
mutable=true.
``POST /uri/$DIRCAP/[SUBDIRS../]?t=upload``
@ -1200,7 +1200,7 @@ Uploading a File
already exist.
This accepts format= and mutable=true query string arguments. Refer to
`Writing/Uploading A File`_ for information on the behavior of format= and
`Writing/Uploading a File`_ for information on the behavior of format= and
mutable=true.
If a "when_done=URL" argument is provided, the HTTP response will cause the
@ -1245,7 +1245,7 @@ Attaching An Existing File Or Directory (by URI)
This accepts the same replace= argument as POST t=upload.
Unlinking A Child
Unlinking a Child
-----------------
``POST /uri/$DIRCAP/[SUBDIRS../]?t=delete&name=CHILDNAME``
@ -1264,7 +1264,7 @@ Unlinking A Child
be used.
Renaming A Child
Renaming a Child
----------------
``POST /uri/$DIRCAP/[SUBDIRS../]?t=rename&from_name=OLD&to_name=NEW``