summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorAlistair Coles <alistair.coles@hpe.com>2016-09-08 16:41:26 +0100
committerAlistair Coles <alistair.coles@hpe.com>2016-09-19 09:18:19 +0100
commit2355771d4bc87d003a7702405c0406363e0aa18b (patch)
treebc10b8a6102a1fe58508a1bd6431f787616d6e74 /api-ref
parent6fea41e0f63739428559dd1e3396f2b04b369bac (diff)
downloadswift-2355771d4bc87d003a7702405c0406363e0aa18b.tar.gz
api-ref: Move repeated paragraph to an include file
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
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/metadata_header_encoding.inc10
-rw-r--r--api-ref/source/metadata_header_syntax.inc7
-rw-r--r--api-ref/source/storage-account-services.inc7
-rw-r--r--api-ref/source/storage-container-services.inc14
-rw-r--r--api-ref/source/storage-object-services.inc12
5 files changed, 18 insertions, 32 deletions
diff --git a/api-ref/source/metadata_header_encoding.inc b/api-ref/source/metadata_header_encoding.inc
index f10ae806a..1aee47bf8 100644
--- a/api-ref/source/metadata_header_encoding.inc
+++ b/api-ref/source/metadata_header_encoding.inc
@@ -1,4 +1,6 @@
-The metadata value must be UTF-8-encoded and then
-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>`_.
+.. note::
+
+ The metadata value must be UTF-8-encoded and then
+ 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>`_.
diff --git a/api-ref/source/metadata_header_syntax.inc b/api-ref/source/metadata_header_syntax.inc
new file mode 100644
index 000000000..771f99dfc
--- /dev/null
+++ b/api-ref/source/metadata_header_syntax.inc
@@ -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.
diff --git a/api-ref/source/storage-account-services.inc b/api-ref/source/storage-account-services.inc
index 4a543787c..1f27c042a 100644
--- a/api-ref/source/storage-account-services.inc
+++ b/api-ref/source/storage-account-services.inc
@@ -184,12 +184,7 @@ Meta-{name}`` header with an arbitrary value. For example,
``X-Remove-Account-Meta-Book: x``. The operation ignores the arbitrary
value.
-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.
-
+.. include:: metadata_header_syntax.inc
.. include:: metadata_header_encoding.inc
Subsequent requests for the same key and value pair overwrite the
diff --git a/api-ref/source/storage-container-services.inc b/api-ref/source/storage-container-services.inc
index a97967532..ebeee1a02 100644
--- a/api-ref/source/storage-container-services.inc
+++ b/api-ref/source/storage-container-services.inc
@@ -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
the metadata item.
-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.
-
+.. include:: metadata_header_syntax.inc
.. include:: metadata_header_encoding.inc
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
the metadata item.
-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.
-
+.. include:: metadata_header_syntax.inc
.. include:: metadata_header_encoding.inc
Subsequent requests for the same key and value pair overwrite the
diff --git a/api-ref/source/storage-object-services.inc b/api-ref/source/storage-object-services.inc
index 5db102016..0bfcf9db9 100644
--- a/api-ref/source/storage-object-services.inc
+++ b/api-ref/source/storage-object-services.inc
@@ -166,11 +166,7 @@ To create custom metadata, use the
``X-Object-Meta-name`` header, where ``name`` is the name of the metadata
item.
-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.
+.. include:: metadata_header_syntax.inc
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
item.
-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.
+.. include:: metadata_header_syntax.inc
In addition to the custom metadata, you can update the
``Content-Type``, ``Content-Encoding``, ``Content-Disposition``, and