From 2355771d4bc87d003a7702405c0406363e0aa18b Mon Sep 17 00:00:00 2001 From: Alistair Coles Date: Thu, 8 Sep 2016 16:41:26 +0100 Subject: [PATCH] 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 --- api-ref/source/metadata_header_encoding.inc | 10 ++++++---- api-ref/source/metadata_header_syntax.inc | 7 +++++++ api-ref/source/storage-account-services.inc | 7 +------ api-ref/source/storage-container-services.inc | 14 ++------------ api-ref/source/storage-object-services.inc | 12 ++---------- 5 files changed, 18 insertions(+), 32 deletions(-) create mode 100644 api-ref/source/metadata_header_syntax.inc diff --git a/api-ref/source/metadata_header_encoding.inc b/api-ref/source/metadata_header_encoding.inc index f10ae806a0..1aee47bf83 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 -`_. +.. 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 + `_. diff --git a/api-ref/source/metadata_header_syntax.inc b/api-ref/source/metadata_header_syntax.inc new file mode 100644 index 0000000000..771f99dfcf --- /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 `_ . + 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 4a543787cb..1f27c042ac 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 `_ . -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 a979675328..ebeee1a025 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 `_ . -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 `_ . -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 5db102016f..0bfcf9db9e 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 `_ . -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 `_ . -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