summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorTin Lam <tinlam@gmail.com>2016-10-17 02:13:29 -0500
committerTin Lam <tinlam@gmail.com>2016-12-09 14:59:40 -0600
commit07d3dd7c7f2d2b1a849b028bc6bfe5c422cccbe5 (patch)
treef88870fe7219be6632006d17ffb591a9c4f1dc3e /api-ref
parente67a57fb17d576239f8865910c9d56361263e0a9 (diff)
downloadswift-07d3dd7c7f2d2b1a849b028bc6bfe5c422cccbe5.tar.gz
Added conditional headers to HEAD request documentation
Currently, conditional headers, e.g. If-Match, If-Modified-Since, etc., are listed for the GET objects API call, but not in the HEAD objects call in the api-ref documentation. This patch adds the missing headers to the HEAD documentation. Change-Id: Idd1c248cc27415d148a1b9a5eb2e95f25b8c4da0 Closes-Bug: #1630212
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/parameters.yaml13
-rw-r--r--api-ref/source/storage-object-services.inc8
2 files changed, 18 insertions, 3 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index b1ae69be5..03c3c592b 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -196,7 +196,18 @@ If-Modified-Since:
in: header
required: false
type: string
-If-None-Match:
+If-None-Match-get-request:
+ description: |
+ A client that has one or more entities previously
+ obtained from the resource can verify that none of those entities is
+ current by including a list of their associated entity tags in the
+ ``If-None-Match header`` field.
+ See `Request for Comments: 2616 <http://www.ietf.org/rfc/rfc2616.txt>`_
+ for details.
+ in: header
+ required: false
+ type: string
+If-None-Match-put-request:
description: |
In combination with ``Expect: 100-Continue``,
specify an ``"If-None-Match: *"`` header to query whether the
diff --git a/api-ref/source/storage-object-services.inc b/api-ref/source/storage-object-services.inc
index 4fcb933a4..53b5873d2 100644
--- a/api-ref/source/storage-object-services.inc
+++ b/api-ref/source/storage-object-services.inc
@@ -113,7 +113,7 @@ Request
- multipart-manifest: multipart-manifest_get
- Range: Range
- If-Match: If-Match
- - If-None-Match: If-None-Match
+ - If-None-Match: If-None-Match-get-request
- If-Modified-Since: If-Modified-Since
- If-Unmodified-Since: If-Unmodified-Since
- X-Trans-Id-Extra: X-Trans-Id-Extra
@@ -255,7 +255,7 @@ Request
- X-Delete-At: X-Delete-At
- X-Delete-After: X-Delete-After
- X-Object-Meta-name: X-Object-Meta-name
- - If-None-Match: If-None-Match
+ - If-None-Match: If-None-Match-put-request
- X-Trans-Id-Extra: X-Trans-Id-Extra
@@ -565,6 +565,10 @@ Request
- filename: filename
- multipart-manifest: multipart-manifest_head
- X-Newest: X-Newest
+ - If-Match: If-Match
+ - If-None-Match: If-None-Match-get-request
+ - If-Modified-Since: If-Modified-Since
+ - If-Unmodified-Since: If-Unmodified-Since
- X-Trans-Id-Extra: X-Trans-Id-Extra