summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorTim Burke <tim.burke@gmail.com>2016-09-20 13:54:55 -0700
committerTim Burke <tim.burke@gmail.com>2016-09-21 16:42:27 -0700
commit60a2fe0ba8e59f4abbb5e9c5a9cd093818d5b26c (patch)
tree34eee76c55cb637fa57dfa9d94e1be8d07ee1dc6 /api-ref
parentb4c1517ddd0d57f556721caf587c113e4abc0498 (diff)
downloadswift-60a2fe0ba8e59f4abbb5e9c5a9cd093818d5b26c.tar.gz
Use separate headers for versioned_writes' stack and history modes
Now, instead of saying X-Versions-Location: <container> X-Versions-Mode: history clients should just say X-History-Location: <container> Since we've never had a release featuring a user-settable X-Versions-Mode header, support may be dropped and that is now ignored. Change-Id: Icfd0f481d4e40dd5375c737190aea7ee8dbc3bf9
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/parameters.yaml60
-rw-r--r--api-ref/source/storage-container-services.inc9
2 files changed, 40 insertions, 29 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index d4c79e8e4..49fb82178 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -621,6 +621,27 @@ X-Fresh-Metadata:
in: header
required: false
type: boolean
+X-History-Location:
+ description: |
+ The URL-encoded UTF-8 representation of the container that stores
+ previous versions of objects. If neither this nor ``X-Versions-Location``
+ is set, versioning is disabled for this container. ``X-History-Location``
+ and ``X-Versions-Location`` cannot both be set at the same time. For more
+ information about object versioning, see `Object versioning
+ <http://docs.openstack.org/ developer/swift/api/object_versioning.html>`_.
+ in: header
+ required: false
+ type: string
+X-History-Location_resp:
+ description: |
+ If present, this container has versioning enabled and the value
+ is the UTF-8 encoded name of another container.
+ For more information about object versioning,
+ see `Object versioning <http://docs.openstack.org/developer/
+ swift/api/object_versioning.html>`_.
+ in: header
+ required: false
+ type: string
X-Newest:
description: |
If set to true , Object Storage queries all
@@ -683,9 +704,17 @@ X-Remove-Container-name:
in: header
required: false
type: string
+X-Remove-History-Location:
+ description: |
+ Set to any value to disable versioning. Note that this disables version
+ that was set via ``X-Versions-Location`` as well.
+ in: header
+ required: false
+ type: string
X-Remove-Versions-Location:
description: |
- Set to any value to disable versioning.
+ Set to any value to disable versioning. Note that this disables version
+ that was set via ``X-History-Location`` as well.
in: header
required: false
type: string
@@ -756,10 +785,11 @@ X-Trans-Id-Extra:
X-Versions-Location:
description: |
The URL-encoded UTF-8 representation of the container that stores
- previous versions of objects. If not set, versioning is disabled
- for this container. For more information about object versioning,
- see `Object versioning <http://docs.openstack.org/developer/
- swift/api/object_versioning.html>`_.
+ previous versions of objects. If neither this nor ``X-History-Location``
+ is set, versioning is disabled for this container. ``X-Versions-Location``
+ and ``X-History-Location`` cannot both be set at the same time. For more
+ information about object versioning, see `Object versioning
+ <http://docs.openstack.org/ developer/swift/api/object_versioning.html>`_.
in: header
required: false
type: string
@@ -773,26 +803,6 @@ X-Versions-Location_resp:
in: header
required: false
type: string
-X-Versions-Mode:
- description: |
- The versioning mode for this container. The value must be either
- ``stack`` or ``history``. If not set, ``stack`` mode will be used.
- This setting has no impact unless ``X-Versions-Location`` is set
- for the container. For more information about object versioning,
- see `Object versioning <http://docs.openstack.org/developer/
- swift/api/object_versioning.html>`_.
- in: header
- required: false
- type: string
-X-Versions-Mode_resp:
- description: |
- If set, this is the versioning mode for this container. The value is either
- ``stack`` or ``history``. For more information about object versioning,
- see `Object versioning <http://docs.openstack.org/developer/
- swift/api/object_versioning.html>`_.
- in: header
- required: false
- type: string
# variables in path
account:
diff --git a/api-ref/source/storage-container-services.inc b/api-ref/source/storage-container-services.inc
index ebeee1a02..fc98dff2a 100644
--- a/api-ref/source/storage-container-services.inc
+++ b/api-ref/source/storage-container-services.inc
@@ -83,7 +83,7 @@ Response Parameters
- X-Container-Sync-Key: X-Container-Sync-Key_resp
- X-Container-Sync-To: X-Container-Sync-To_resp
- X-Versions-Location: X-Versions-Location_resp
- - X-Versions-Mode: X-Versions-Mode_resp
+ - X-History-Location: X-History-Location_resp
- X-Timestamp: X-Timestamp
- X-Trans-Id: X-Trans-Id
- Content_Type: Content-Type_listing_resp
@@ -197,7 +197,7 @@ Request
- X-Container-Sync-To: X-Container-Sync-To
- X-Container-Sync-Key: X-Container-Sync-Key
- X-Versions-Location: X-Versions-Location
- - X-Versions-Mode: X-Versions-Mode
+ - X-History-Location: X-History-Location
- X-Container-Meta-name: X-Container-Meta-name_req
- X-Container-Meta-Access-Control-Allow-Origin: X-Container-Meta-Access-Control-Allow-Origin
- X-Container-Meta-Access-Control-Max-Age: X-Container-Meta-Access-Control-Max-Age
@@ -331,8 +331,9 @@ Request
- X-Container-Sync-To: X-Container-Sync-To
- X-Container-Sync-Key: X-Container-Sync-Key
- X-Versions-Location: X-Versions-Location
- - X-Versions-Mode: X-Versions-Mode
+ - X-History-Location: X-History-Location
- X-Remove-Versions-Location: X-Remove-Versions-Location
+ - X-Remove-History-Location: X-Remove-History-Location
- X-Container-Meta-name: X-Container-Meta-name_req
- X-Container-Meta-Access-Control-Allow-Origin: X-Container-Meta-Access-Control-Allow-Origin
- X-Container-Meta-Access-Control-Max-Age: X-Container-Meta-Access-Control-Max-Age
@@ -436,7 +437,7 @@ Response Parameters
- X-Trans-Id: X-Trans-Id
- Content-Type: Content-Type_cud_resp
- X-Versions-Location: X-Versions-Location_resp
- - X-Versions-Mode: X-Versions-Mode_resp
+ - X-History-Location: X-History-Location_resp
- X-Storage-Policy: X-Storage-Policy