openstack/swift
Code Issues Proposed changes

Fixed Errors in Swift-Form Post middleware section rst.

Browse Source 
Inline markup cannot be nested in RST.
Fixing markups by using a single option for the whole line and making
some minor error corrections.

Change-Id: I42bfd7dfe5c93a69436ecc5d154f2e61ca83fa82
This commit is contained in:
janonymous 2015-06-24 21:07:16 +05:30
parent 514daea631
commit c2c1366b07
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/source/api/form_post_middleware.rst
View File

@ -5,7 +5,7 @@ Form POST middleware
==================== ====================
To discover whether your Object Storage system supports this feature, To discover whether your Object Storage system supports this feature,
check with your service provider or send a **GET** request using the ``/info`` check with your service provider or send a **GET** request using the :file:`/info`
path. path.
You can upload objects directly to the Object Storage system from a You can upload objects directly to the Object Storage system from a
@ -35,7 +35,7 @@ The format of the form **POST** request is:
.. code:: .. code::
&lt;![CDATA[ <![CDATA[
<form action="SWIFT_URL" <form action="SWIFT_URL"
method="POST" method="POST"
enctype="multipart/form-data"> enctype="multipart/form-data">
@ -48,13 +48,13 @@ The format of the form **POST** request is:
<br/> <br/>
<input type="submit"/> <input type="submit"/>
</form> </form>
]]&gt; ]]>
**action="SWIFT_URL"** **action="SWIFT_URL"**
Set to full URL where the objects are to be uploaded. The names of Set to full URL where the objects are to be uploaded. The names of
uploaded files are appended to the specified *``SWIFT_URL``*. So, you uploaded files are appended to the specified *SWIFT_URL*. So, you
can upload directly to the root of a container with a URL like: can upload directly to the root of a container with a URL like:
.. code:: .. code::
@ -79,39 +79,39 @@ Must be ``POST``.
Must be ``multipart/form-data``. Must be ``multipart/form-data``.
**name="redirect" value="*``REDIRECT_URL``*\ "** **name="redirect" value="REDIRECT_URL"**
Redirects the browser to the *``REDIRECT_URL``* after the upload Redirects the browser to the *REDIRECT_URL* after the upload
completes. The URL has status and message query parameters added to it, completes. The URL has status and message query parameters added to it,
which specify the HTTP status code for the upload and an optional error which specify the HTTP status code for the upload and an optional error
message. The 2\ *``nn``* status code indicates success. message. The 2\ *nn* status code indicates success.
The *``REDIRECT_URL``* can be an empty string. If so, the ``Location`` The *REDIRECT_URL* can be an empty string. If so, the ``Location``
response header is not set. response header is not set.
**name="max\_file\_size" value="*``BYTES``*\ "** **name="max\_file\_size" value="BYTES"**
Required. Indicates the size, in bytes, of the maximum single file Required. Indicates the size, in bytes, of the maximum single file
upload. upload.
**name="max\_file\_count" value= "*``COUNT``*\ "** **name="max\_file\_count" value= "COUNT"**
Required. Indicates the maximum number of files that can be uploaded Required. Indicates the maximum number of files that can be uploaded
with the form. with the form.
**name="expires" value="*``UNIX_TIMESTAMP``*\ "** **name="expires" value="UNIX_TIMESTAMP"**
The UNIX timestamp that specifies the time before which the form must be The UNIX timestamp that specifies the time before which the form must be
submitted before it becomes no longer valid. submitted before it becomes no longer valid.
**name="signature" value="*``HMAC``*\ "** **name="signature" value="HMAC"**
The HMAC-SHA1 signature of the form. The HMAC-SHA1 signature of the form.
**type="file" name="*``FILE_NAME``*\ "** **type="file" name="FILE_NAME"**
File name of the file to be uploaded. You can include from one to the File name of the file to be uploaded. You can include from one to the
``max_file_count`` value of files. ``max_file_count`` value of files.
@ -144,7 +144,7 @@ Form **POST** middleware uses an HMAC-SHA1 cryptographic signature. This
signature includes these elements from the form: signature includes these elements from the form:
- The path. Starting with ``/v1/`` onwards and including a container - The path. Starting with ``/v1/`` onwards and including a container
name and, optionally, an object prefix. In `Example 1.15, “HMAC-SHA1 name and, optionally, an object prefix. In `Example 1.15`, “HMAC-SHA1
signature for form signature for form
POST” the path is POST” the path is
``/v1/my_account/container/object_prefix``. Do not URL-encode the ``/v1/my_account/container/object_prefix``. Do not URL-encode the
@ -152,11 +152,11 @@ signature includes these elements from the form:
- A redirect URL. If there is no redirect URL, use the empty string. - A redirect URL. If there is no redirect URL, use the empty string.
- Maximum file size. In `Example 1.15, “HMAC-SHA1 signature for form - Maximum file size. In `Example 1.15`, “HMAC-SHA1 signature for form
POST” the POST” the
``max_file_size`` is ``104857600`` bytes. ``max_file_size`` is ``104857600`` bytes.
- The maximum number of objects to upload. In `Example 1.15, “HMAC-SHA1 - The maximum number of objects to upload. In `Example 1.15`, “HMAC-SHA1
signature for form signature for form
POST” ``max_file_count`` is ``10``. POST” ``max_file_count`` is ``10``.