openstack/swift
Code Issues Proposed changes

api-ref: Move repeated paragraph to an include file

Browse Source 
Move repeated test re metadata header syntax to an include
file and make it be rendered as a note.

Also make already included text about metadata header value
encoding be a note.

Change-Id: I4795836587492954ad24dd5baaa5d668746d6040
This commit is contained in:
Alistair Coles 2016-09-08 16:41:26 +01:00
parent 6fea41e0f6
commit 2355771d4b
5 changed files with 18 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api-ref/source/metadata_header_encoding.inc
View File

@ -1,4 +1,6 @@
The metadata value must be UTF-8-encoded and then .. note::
URL-encoded before you include it in the header.
This is a direct violation of the HTTP/1.1 `basic rules The metadata value must be UTF-8-encoded and then
<http://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html#sec2.2>`_. URL-encoded before you include it in the header.
This is a direct violation of the HTTP/1.1 `basic rules
<http://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html#sec2.2>`_.

7
api-ref/source/metadata_header_syntax.inc Normal file
View File

@ -0,0 +1,7 @@
.. note::
Metadata keys (the name of the metadata) must be treated as case-insensitive
at all times. These keys can contain ASCII 7-bit characters that are not
control (0-31) characters, DEL, or a separator character, according to
`HTTP/1.1 <http://www.w3.org/Protocols/rfc2616/rfc2616.html>`_ .
The underscore character is silently converted to a hyphen.

7
api-ref/source/storage-account-services.inc
View File

@ -184,12 +184,7 @@ Meta-{name}`` header with an arbitrary value. For example,
``X-Remove-Account-Meta-Book: x``. The operation ignores the arbitrary ``X-Remove-Account-Meta-Book: x``. The operation ignores the arbitrary
value. value.
Metadata keys (the name of the metadata) must be treated as case-insensitive .. include:: metadata_header_syntax.inc
at all times. These keys can contain ASCII 7-bit characters that are not
control (0-31) characters, DEL, or a separator character, according to
`HTTP/1.1 <http://www.w3.org/Protocols/rfc2616/rfc2616.html>`_ .
The underscore character is silently converted to a hyphen.
.. include:: metadata_header_encoding.inc .. include:: metadata_header_encoding.inc
Subsequent requests for the same key and value pair overwrite the Subsequent requests for the same key and value pair overwrite the

14
api-ref/source/storage-container-services.inc
View File

@ -124,12 +124,7 @@ To create, update, or delete a custom metadata item, use the ``X
-Container-Meta-{name}`` header, where ``{name}`` is the name of -Container-Meta-{name}`` header, where ``{name}`` is the name of
the metadata item. the metadata item.
Metadata keys (the name of the metadata) must be treated as case-insensitive .. include:: metadata_header_syntax.inc
at all times. These keys can contain ASCII 7-bit characters that are not
control (0-31) characters, DEL, or a separator character, according to
`HTTP/1.1 <http://www.w3.org/Protocols/rfc2616/rfc2616.html>`_ .
The underscore character is silently converted to a hyphen.
.. include:: metadata_header_encoding.inc .. include:: metadata_header_encoding.inc
Example requests and responses: Example requests and responses:
@ -240,12 +235,7 @@ To create, update, or delete a custom metadata item, use the ``X
-Container-Meta-{name}`` header, where ``{name}`` is the name of -Container-Meta-{name}`` header, where ``{name}`` is the name of
the metadata item. the metadata item.
Metadata keys (the name of the metadata) must be treated as case-insensitive .. include:: metadata_header_syntax.inc
at all times. These keys can contain ASCII 7-bit characters that are not
control (0-31) characters, DEL, or a separator character, according to
`HTTP/1.1 <http://www.w3.org/Protocols/rfc2616/rfc2616.html>`_ .
The underscore character is silently converted to a hyphen.
.. include:: metadata_header_encoding.inc .. include:: metadata_header_encoding.inc
Subsequent requests for the same key and value pair overwrite the Subsequent requests for the same key and value pair overwrite the

12
api-ref/source/storage-object-services.inc
View File

@ -166,11 +166,7 @@ To create custom metadata, use the
``X-Object-Meta-name`` header, where ``name`` is the name of the metadata ``X-Object-Meta-name`` header, where ``name`` is the name of the metadata
item. item.
Metadata keys (the name of the metadata) must be treated as case-insensitive .. include:: metadata_header_syntax.inc
at all times. These keys can contain ASCII 7-bit characters that are not
control (0-31) characters, DEL, or a separator character, according to
`HTTP/1.1 <http://www.w3.org/Protocols/rfc2616/rfc2616.html>`_ .
The underscore character is silently converted to a hyphen.
Example requests and responses: Example requests and responses:
@ -599,11 +595,7 @@ To create or update custom metadata, use the
``X-Object-Meta-name`` header, where ``name`` is the name of the metadata ``X-Object-Meta-name`` header, where ``name`` is the name of the metadata
item. item.
Metadata keys (the name of the metadata) must be treated as case-insensitive .. include:: metadata_header_syntax.inc
at all times. These keys can contain ASCII 7-bit characters that are not
control (0-31) characters, DEL, or a separator character, according to
`HTTP/1.1 <http://www.w3.org/Protocols/rfc2616/rfc2616.html>`_ .
The underscore character is silently converted to a hyphen.
In addition to the custom metadata, you can update the In addition to the custom metadata, you can update the
``Content-Type``, ``Content-Encoding``, ``Content-Disposition``, and ``Content-Type``, ``Content-Encoding``, ``Content-Disposition``, and