From 9d4e7a50fced7f27057d208a9d11e23b3528297a Mon Sep 17 00:00:00 2001 From: "Frederick F. Kautz IV" Date: Mon, 2 Feb 2015 15:41:21 -0800 Subject: [PATCH] Adding minio api documentation --- docs/docs/api/minio.md | 158 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 153 insertions(+), 5 deletions(-) diff --git a/docs/docs/api/minio.md b/docs/docs/api/minio.md index 6baf7acb2..6fc18d434 100644 --- a/docs/docs/api/minio.md +++ b/docs/docs/api/minio.md @@ -1,14 +1,162 @@ # Minio API +## General Overview + +Minio stores and retrieves data in a logical format based upon REST +based URLs. + +``` +Form: +http://minio.example.com/{bucket}/{path:.*} + +Examples: +http://minio.example.com/bucket/object +http://minio.example.com/bucket/path/to/object +http://minio.example.com/bucket2/path/to/object +``` + ## / -## GET /bucket/ +List buckets accessible by the user. -## PUT /bucket/ +Example: +``` +GET / HTTP/1.1 +``` +``` +HTTP/1.1 200 OK +Connection: close +Content-Type: application/xml +Server: Minio +Date: Mon, 02 Feb 2015 22:09:00 GMT +Content-Length: 306 -## GET /bucket/object + + + minio + minio + + + + bucket + 2015-01-30T15:20:09.013Z + + + minio + 2015-01-27T17:46:28.264Z + + + +``` -## HEAD /bucket/object +## GET /{bucket}/ -## PUT /bucket/object +Lists objects in a bucket. + +Example: +``` +GET /minio/ HTTP/1.1 +``` +``` +HTTP/1.1 200 OK +Connection: close +Content-Type: application/xml +Server: Minio +Date: Mon, 02 Feb 2015 22:07:20 GMT +Content-Length: 352 + + + + minio + + 1000 + false + + one + 2015-01-27T17:46:28.264Z + minio#one + 4096 + STANDARD + + minio + minio + + + +``` + +## PUT /{bucket}/ + +Example: +``` +PUT /books/ HTTP/1.1 +``` +``` +HTTP/1.1 200 OK +Connection: close +Server: Minio +Date: Mon, 02 Feb 2015 22:05:43 GMT +Content-Length: 0 +Content-Type: text/plain; charset=utf-8 +``` + +EXAMPLE +## GET /{bucket}/{object} + +``` +GET /minio/hello HTTP/1.1 +``` +``` +HTTP/1.1 200 OK +Connection: close +Content-Length: 75 +Content-Type: text/plain +Etag: minio#hello +Last-Modified: Mon, 02 Feb 2015 14:52:34 PST +Server: Minio +Date: Mon, 02 Feb 2015 22:59:51 GMT + + + + + Hello World! + +``` + +Retrieves an object from a bucket + +## HEAD /{bucket}/{object} +``` +HEAD /minio/hello HTTP/1.1 +``` +``` +HTTP/1.1 200 OK +Connection: close +Content-Length: 75 +Content-Type: text/plain +Etag: minio#hello +Last-Modified: Mon, 02 Feb 2015 14:52:34 PST +Server: Minio +Date: Mon, 02 Feb 2015 23:02:30 GMT +``` + +Retrieves meta-data about an object + +## PUT /{bucket}/{object} + +Stores an object + +``` +PUT /minio/hello HTTP/1.1 +Content-Length: 75 + + + + + Hello World! + +``` +``` +HTTP/1.1 200 OK +```