! Copyright (C) 2009 Chris Double.\r
! See http://factorcode.org/license.txt for BSD license.\r
-USING: help.markup help.syntax ;\r
+USING: assocs help.markup help.syntax kernel strings ;\r
IN: s3\r
\r
HELP: buckets\r
\r
HELP: create-bucket\r
{ $values \r
- { "bucket" "a string" } \r
+ { "bucket" string } \r
}\r
{ $description \r
"Creates a bucket with the given name."\r
\r
HELP: delete-bucket\r
{ $values \r
- { "bucket" "a string" } \r
+ { "bucket" string } \r
}\r
{ $description \r
"Deletes the bucket with the given name."\r
\r
HELP: keys\r
{ $values \r
- { "bucket" "a string" } \r
+ { "bucket" string } \r
{ "seq" "a sequence of " { $link key } " objects"} \r
}\r
{ $description \r
\r
HELP: get-object\r
{ $values \r
- { "bucket" "a string" } \r
- { "key" "a string" } \r
- { "response" "The HTTP response object"} \r
- { "data" "The data returned from the http request"} \r
+ { "bucket" string }\r
+ { "key" string }\r
+ { "response" "The HTTP response object"}\r
+ { "data" "The data returned from the http request"}\r
}\r
{ $description \r
"Does an HTTP request to retrieve the object in the bucket with the given key."\r
;\r
\r
HELP: put-object\r
-{ $values \r
- { "data" "an object" } \r
- { "mime-type" "a string" } \r
- { "bucket" "a string"} \r
- { "key" "a string"} \r
- { "headers" "an assoc"} \r
+{ $values\r
+ { "data" object }\r
+ { "mime-type" string }\r
+ { "bucket" string }\r
+ { "key" string }\r
+ { "headers" assoc }\r
}\r
{ $description \r
"Stores the object under the key in the given bucket. The object has "\r
\r
HELP: delete-object\r
{ $values \r
- { "bucket" "a string"} \r
- { "key" "a string"} \r
+ { "bucket" string }\r
+ { "key" string }\r
}\r
{ $description \r
"Deletes the object in the bucket with the given key."\r