Merge pull request #157 from harshavardhana/pr_out_reorg_docs_and_cleanup

master
Harshavardhana 10 years ago
commit be1b50247a
  1. 2
      README.md
  2. 3
      docs/api/manage.md
  3. 2
      docs/architecture.md
  4. 6
      docs/errors.md
  5. 16
      docs/index.md
  6. 2
      docs/introduction.md
  7. 3
      docs/manage.md
  8. 18
      docs/minio.md
  9. 12
      mkdocs.yml

@ -8,7 +8,7 @@ Minio's design is inspired by Amazon's S3 for its API and Facebook's Haystack fo
* Ask questions on Quora [![Quora](http://upload.wikimedia.org/wikipedia/commons/thumb/5/57/Quora_logo.svg/55px-Quora_logo.svg.png)](http://www.quora.com/Minio)
### Documentation
* [Minio API](https://minio-io.github.io/minio/api/minio/)
* [Minio Reference](http://minio-io.github.io/minio/)
### Developers
* [Get Source](./CONTRIBUTING.md)

@ -1,3 +0,0 @@
# Management API
# GET /

@ -1 +1 @@
# Architecture
### Overview

@ -1,8 +1,8 @@
# List of Error Responses
### List of Error Responses
This section provides information about Minio API errors. XML and JSON results have been prettified for readability. As a result, the Content-Length may not match exactly for both styles
### Error Codes Table
#### Error Codes Table
The following table lists Minio error codes.
@ -31,7 +31,7 @@ The following table lists Minio error codes.
| TooManyBuckets | You have attempted to create more buckets than allowed. | 400 Bad Request |
<br />
### REST Error Responses
#### REST Error Responses
When there is an error, the header information contains:

@ -1,13 +1,11 @@
# Welcome to MINIO
# Welcome to *MINIO*
Welcome to the *Minio API Reference*. It explains the Minio application programming interface. It describes various API operations, related request and response structures, and error codes.
Minio is an open source object storage released under [Apache license v2](http://www.apache.org/licenses/LICENSE-2.0).
Minio is an open source object storage released under [Apache license v2](http://www.apache.org/licenses/LICENSE-2.0). It uses ``Rubberband Erasure`` coding to dynamically protect the data.
It uses ``Rubberband Erasure`` coding to dynamically protect the data. This documents explains various API operations, related request and response structures, and error codes.
## How?
## Topics
| Information | Sections |
|:------------- |:-------------:|
| Overview | Minio |
| REST | [Minio API](./api/minio.md) |
| Error List | [Error Codes](./api/errors.md) |
- [Minio](./architecture.md)
- [Minio API](./minio.md)
- [Error Codes](./errors.md)

@ -1,3 +1,3 @@
# Minio API Reference
### Minio API Reference
This API reference explains Minio operations, their parameters, responses, and errors. There are separate sections for each API, which include example requests and responses.

@ -0,0 +1,3 @@
### Management API
#### GET /

@ -1,10 +1,10 @@
# Minio API
### Minio API
## General Overview
#### General Overview
Minio stores and retrieves data in a logical format based upon REST based URLs.
### Note about examples:
**Note about examples:**
XML and JSON results have been prettified for readability. As a result, the Content-Length may not match exactly.
```
@ -17,7 +17,7 @@ http://minio.example.com/bucket/path/to/object
http://minio.example.com/bucket2/path/to/object
```
## GET /
#### GET /
List buckets accessible by the user.
@ -92,7 +92,7 @@ Content-Length: 223
NOTE: ``Accept: application/json`` is Minio Object Server specific
## GET /{bucket}/
#### GET /{bucket}/
Lists objects in a bucket.
@ -138,7 +138,7 @@ Content-Length: 579
</ListBucketResult>
```
## PUT /{bucket}/
#### PUT /{bucket}/
Example:
```
@ -154,7 +154,7 @@ Content-Type: text/plain; charset=utf-8
```
EXAMPLE
## GET /{bucket}/{object}
#### GET /{bucket}/{object}
```
GET /minio/hello HTTP/1.1
@ -178,7 +178,7 @@ Date: Mon, 02 Feb 2015 22:59:51 GMT
Retrieves an object from a bucket
## HEAD /{bucket}/{object}
#### HEAD /{bucket}/{object}
```
HEAD /minio/hello HTTP/1.1
```
@ -195,7 +195,7 @@ Date: Mon, 02 Feb 2015 23:02:30 GMT
Retrieves meta-data about an object
## PUT /{bucket}/{object}
#### PUT /{bucket}/{object}
Stores an object

@ -1,10 +1,10 @@
site_name: Minio Documentation
pages:
- ['index.md', Welcome to Minio]
- ['introduction.md', Minio API Reference]
- ['api/minio.md', 'API', 'REST API']
- ['api/errors.md', 'API', 'Error Responses']
- ['api/manage.md', 'API', 'Management']
- ['architecture.md', 'Architecture', 'Overview']
- ['contributing.md', 'Contributing', 'Overview']
- ['architecture.md', 'Minio', Architecture]
- ['contributing.md', 'Minio', Contribute]
- ['introduction.md', 'API', Reference]
- ['minio.md', 'API', REST API]
- ['errors.md', 'API', Error Responses]
- ['manage.md', 'API', Management API]
theme: readthedocs

Loading…
Cancel
Save