Remove preprocessor tests for OpenSSL. It's a requirement.

[citadel.git] / webcit-ng / api.txt

diff --git a/webcit-ng/api.txt b/webcit-ng/api.txt
index f148f53c5e03fa790ff0b5f87cf0f08f2f30fd14..8660c8f2ca7d20f17fc0a243d90e3247993fb963 100644 (file)
--- a/webcit-ng/api.txt
+++ b/webcit-ng/api.txt
@@ -1,7 +1,9 @@
 Method          URL                                Function
 ------          ------------------------------     -------------------------------------
 GET             /                                  Site root will redirect to a landing page
+
 GET             /ctdl/f/                           returns a JSON-encoded list of accessible floors
+
 GET             /ctdl/r/                           returns a JSON-encoded list of accessible rooms
 OPTIONS         /ctdl/r/<roomname>/                returns just what you'd expect
 PROPFIND        /ctdl/r/<roomname>/                Show a bunch of crap
@@ -14,8 +16,8 @@ GET             /ctdl/r/<roomname>/stat            JSON dictionary of the server
 GET             /ctdl/r/<roomname>/<msgnum>        Retrieve the content of an individual message
 GET             /ctdl/r/<roomname>/<msgnum>/json   Retrieve an individual message in a room, encapsulated in JSON
 GET             /ctdl/r/<roomname>/<msgnum>/<part> Retrieve a MIME component of a message, specified by partnum
-DELETE          /ctdl/r/<roomname>/<msgnum>        Deletes a message from a room
-MOVE            /ctdl/r/<roomname>/<msgnum>        Moves a message to another room (requires Destination)
+DELETE          /ctdl/r/<roomname>/<msgnum>        Delete a message from a room
+MOVE            /ctdl/r/<roomname>/<msgnum>        Move a message to another room (requires Destination)
 
 PUT             /ctdl/r/<roomname>/<xxx>           DAV operation to insert a new message into a room
                 Accepted parameters:
@@ -44,5 +46,7 @@ POST            /ctdl/p                            Handler for uploading attachm
                                                        "contentlength" : 56222252
                                                      }
                                                    ]
-GET             /ctdl/p/<id>                       Fetch a specific item that was uploaded
-DELETE          /ctdl/p/<id>                       Delete a specific item that was uploaded
+GET             /ctdl/p/<ref>                      Fetch a specific item that was uploaded ("ref" was returned by the upload)
+DELETE          /ctdl/p/<ref>                      Delete a specific item that was uploaded ("ref" was returned by the upload)
+GET             /ctdl/p/<msgnum>                   Load the attachments from message <msgnum> in, as if they were uploaded
+                                                   by the client.  Returns the same JSON as "POST /ctdl/p".