Skip to content

Commit

Permalink
Doc: API.md/Modifications to sync with doctor. (#427)
Browse files Browse the repository at this point in the history
  • Loading branch information
@harshavardhana
koolhead17 authored and harshavardhana committed Jul 23, 2016
1 parent 0384e92 commit a51f8e2
Showing 1 changed file with 107 additions and 107 deletions.
214 changes: 107 additions & 107 deletions docs/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@ __Parameters__
<tbody>
<tr>
<td>
endpoint
<code>endpoint<code>
</td>
<td>
String
<i> String </i>
</td>
<td>
Endpoint is an URL, domain name, IPv4 or IPv6 address.<br/>
Expand All @@ -129,38 +129,38 @@ Valid endpoints:
</tr>
<tr>
<td>
port
<code>port</code>
</td>
<td>
int
<i>int</i>
</td>
<td>
TCP/IP port number. This input is optional. Default value set to 80 for HTTP and 443 for HTTPs.
</td>
</tr>
<tr>
<td>accessKey</td>
<td>String</td>
<td> <code>accessKey</code> </td>
<td> <i>String</i> </td>
<td>Access key to access service in endpoint.</td>
</tr>
<tr>
<td>secretKey</td>
<td>String</td>
<td> <code>secretKey</code> </td>
<td> <i>String </i> </td>
<td>Secret key to access service in endpoint.</td>
</tr>
<tr>
<td>secure</td>
<td>boolean</td>
<td> <code>secure</code> </td>
<td> <i>boolean</i> </td>
<td>If true, access endpoint using HTTPS else access it using HTTP.</td>
</tr>
<tr>
<td>url</td>
<td>URL</td>
<td> <code>url<code> </td>
<td> <i>URL</i> </td>
<td>Endpoint URL object.</td>
</tr>
<tr>
<td>url</td>
<td>HttpURL</td>
<td> <code>url<code> </td>
<td> <i>HttpURL</i> </td>
<td>Endpoint HttpUrl object.</td>
</tr>

Expand Down Expand Up @@ -268,12 +268,12 @@ __Parameters__
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -321,15 +321,15 @@ Lists all buckets.
<tbody>
<tr>
<td>
List Bucket : List of bucket type.
<code>List Bucket</code> : List of bucket type.
</td>
<td>
<ul>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -383,16 +383,16 @@ __Parameters__
<tbody>
<tr>
<td>
boolean: true if the bucket exists
<code> boolean</code>: true if the bucket exists
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -454,12 +454,12 @@ __Parameters__
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -620,16 +620,16 @@ __Parameters__
<tbody>
<tr>
<td>
InputStream: InputStream containing the object data.
<code>InputStream</code>: InputStream containing the object data.
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -698,16 +698,16 @@ __Parameters__
<tbody>
<tr>
<td>
InputStream: InputStream containing the object's data.
<code>InputStream</code> : InputStream containing the object's data.
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -778,12 +778,12 @@ __Parameters__
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -844,12 +844,12 @@ __Parameters__
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -928,12 +928,12 @@ __Parameters__
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -988,16 +988,16 @@ __Parameters__
</thead>
<tbody>
<tr>
<td> ObjectStat: Populated object meta data.
<td> <code>ObjectStat</code>: Populated object meta data.
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -1051,12 +1051,12 @@ __Parameters__
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -1113,12 +1113,12 @@ __Parameters__
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>NoResponseException : upon no response from server.</li>
<li>IOException : upon connection error.</li>
<li>org.xmlpull.v1.XmlPullParserException : upon parsing response XML.</li>
<li>ErrorResponseException : upon unsuccessful execution.</li>
<li>InternalException : upon internal library error.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>NoResponseException</code> : upon no response from server.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>org.xmlpull.v1.XmlPullParserException</code> : upon parsing response XML.</li>
<li> <code>ErrorResponseException</code> : upon unsuccessful execution.</li>
<li> <code>InternalException</code> : upon internal library error.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -1171,15 +1171,15 @@ __Parameters__
</thead>
<tbody>
<tr>
<td> String: string contains URL to download the object.
<td> <code>String</code> : string contains URL to download the object.
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>InvalidKeyException : upon an invalid access key or secret key.</li>
<li>IOException : upon connection error.</li>
<li>NoSuchAlgorithmException : upon requested algorithm was not found during signature calculation.</li>
<li>InvalidExpiresRangeException : upon input expires is out of range.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>InvalidKeyException</code> : upon an invalid access key or secret key.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>NoSuchAlgorithmException</code> : upon requested algorithm was not found during signature calculation.</li>
<li> <code>InvalidExpiresRangeException</code> : upon input expires is out of range.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -1230,15 +1230,15 @@ __Parameters__
</thead>
<tbody>
<tr>
<td> String: string contains URL to download the object.
<td> <code>String</code>: string contains URL to download the object.
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>InvalidKeyException : upon an invalid access key or secret key.</li>
<li>IOException : upon connection error.</li>
<li>NoSuchAlgorithmException : upon requested algorithm was not found during signature calculation.</li>
<li>InvalidExpiresRangeException : upon input expires is out of range.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>InvalidKeyException</code> : upon an invalid access key or secret key.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>NoSuchAlgorithmException</code> : upon requested algorithm was not found during signature calculation.</li>
<li> <code>InvalidExpiresRangeException</code> : upon input expires is out of range.</li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -1290,14 +1290,14 @@ __Parameters__
</thead>
<tbody>
<tr>
<td> Map<String,String>: Map of strings to construct form-data.
<td> <code>Map<String,String></code>: Map of strings to construct form-data.
</td>
<td>
<ul>
<li>InvalidBucketNameException : upon invalid bucket name.</li>
<li>InvalidKeyException : upon an invalid access key or secret key.</li>
<li>IOException : upon connection error.</li>
<li>NoSuchAlgorithmException : upon requested algorithm was not found during signature calculation.</li>
<li> <code>InvalidBucketNameException</code> : upon invalid bucket name.</li>
<li> <code>InvalidKeyException</code> : upon an invalid access key or secret key.</li>
<li> <code>IOException</code> : upon connection error.</li>
<li> <code>NoSuchAlgorithmException</code> : upon requested algorithm was not found during signature calculation.</li>
</ul>
</td>
</tr>
Expand Down

0 comments on commit a51f8e2

Please sign in to comment.