Document that x-delete-after takes precedence over x-delete-at

Change-Id: Ib2483444d3999e13ba83ca2edd3a8ef8e5c48548
This commit is contained in:
Alistair Coles 2018-01-05 14:43:12 +00:00
parent 3aa17e6dc8
commit 582460ecf9
3 changed files with 29 additions and 13 deletions

View File

@ -692,18 +692,31 @@ X-Copy-From-Account:
type: string type: string
X-Delete-After: X-Delete-After:
description: | description: |
The number of seconds after which the system The number of seconds after which the system removes the object. The value
removes the object. Internally, the Object Storage system stores should be a positive integer. Internally, the Object Storage system uses
this value in the ``X-Delete-At`` metadata item. this value to generate an ``X-Delete-At`` metadata item. If both
``X-Delete-After`` and ``X-Delete-At`` are set then ``X-Delete-After``
takes precedence.
in: header in: header
required: false required: false
type: integer type: integer
X-Delete-At: X-Delete-At:
description: | description: |
The date and time in `UNIX Epoch time stamp The date and time in `UNIX Epoch time stamp format
format <https://en.wikipedia.org/wiki/Unix_time>`_ when the system <https://en.wikipedia.org/wiki/Unix_time>`_ when the system removes the
removes the object. For example, ``1440619048`` is equivalent to object. For example, ``1440619048`` is equivalent to ``Mon, Wed, 26 Aug
``Mon, Wed, 26 Aug 2015 19:57:28 GMT``. 2015 19:57:28 GMT``. The value should be a positive integer corresponding
to a time in the future. If both ``X-Delete-After`` and ``X-Delete-At`` are
set then ``X-Delete-After`` takes precedence.
in: header
required: false
type: integer
X-Delete-At_resp:
description: |
If present, specifies date and time in `UNIX Epoch time stamp format
<https://en.wikipedia.org/wiki/Unix_time>`_ when the system removes the
object. For example, ``1440619048`` is equivalent to ``Mon, Wed, 26 Aug
2015 19:57:28 GMT``.
in: header in: header
required: false required: false
type: integer type: integer

View File

@ -130,7 +130,7 @@ Response Parameters
- X-Object-Meta-name: X-Object-Meta-name_resp - X-Object-Meta-name: X-Object-Meta-name_resp
- Content-Disposition: Content-Disposition_resp - Content-Disposition: Content-Disposition_resp
- Content-Encoding: Content-Encoding_resp - Content-Encoding: Content-Encoding_resp
- X-Delete-At: X-Delete-At - X-Delete-At: X-Delete-At_resp
- Accept-Ranges: Accept-Ranges - Accept-Ranges: Accept-Ranges
- X-Object-Manifest: X-Object-Manifest_resp - X-Object-Manifest: X-Object-Manifest_resp
- Last-Modified: Last-Modified - Last-Modified: Last-Modified
@ -602,7 +602,7 @@ Response Parameters
- X-Object-Meta-name: X-Object-Meta-name - X-Object-Meta-name: X-Object-Meta-name
- Content-Disposition: Content-Disposition_resp - Content-Disposition: Content-Disposition_resp
- Content-Encoding: Content-Encoding_resp - Content-Encoding: Content-Encoding_resp
- X-Delete-At: X-Delete-At - X-Delete-At: X-Delete-At_resp
- X-Object-Manifest: X-Object-Manifest_resp - X-Object-Manifest: X-Object-Manifest_resp
- Last-Modified: Last-Modified - Last-Modified: Last-Modified
- ETag: ETag_obj_resp - ETag: ETag_obj_resp
@ -752,9 +752,9 @@ Request
- X-Service-Token: X-Service-Token - X-Service-Token: X-Service-Token
- X-Object-Meta-name: X-Object-Meta-name - X-Object-Meta-name: X-Object-Meta-name
- X-Delete-At: X-Delete-At - X-Delete-At: X-Delete-At
- X-Delete-After: X-Delete-After
- Content-Disposition: Content-Disposition - Content-Disposition: Content-Disposition
- Content-Encoding: Content-Encoding - Content-Encoding: Content-Encoding
- X-Delete-After: X-Delete-After
- Content-Type: Content-Type_obj_cu_req - Content-Type: Content-Type_obj_cu_req
- X-Trans-Id-Extra: X-Trans-Id-Extra - X-Trans-Id-Extra: X-Trans-Id-Extra

View File

@ -11,9 +11,12 @@ object from the system.
The ``X-Delete-At`` header takes a Unix Epoch timestamp, in integer form; for The ``X-Delete-At`` header takes a Unix Epoch timestamp, in integer form; for
example: ``1317070737`` represents ``Mon Sep 26 20:58:57 2011 UTC``. example: ``1317070737`` represents ``Mon Sep 26 20:58:57 2011 UTC``.
The ``X-Delete-After`` header takes an integer number of seconds. The proxy The ``X-Delete-After`` header takes a positive integer number of seconds. The
server that receives the request will convert this header into an proxy server that receives the request will convert this header into an
``X-Delete-At`` header using its current time plus the value given. ``X-Delete-At`` header using the request timestamp plus the value given.
If both the ``X-Delete-At`` and ``X-Delete-After`` headers are sent with a
request then the ``X-Delete-After`` header will take precedence.
As expiring objects are added to the system, the object servers will record the As expiring objects are added to the system, the object servers will record the
expirations in a hidden ``.expiring_objects`` account for the expirations in a hidden ``.expiring_objects`` account for the