diff options
| author | Alistair Coles <alistairncoles@gmail.com> | 2018-01-05 14:43:12 +0000 |
|---|---|---|
| committer | Alistair Coles <alistairncoles@gmail.com> | 2018-01-05 19:50:50 +0000 |
| commit | 582460ecf9d503c10fd73c055301634b0b009dbc (patch) | |
| tree | fcaa0adef9b580955dff876fdc5571f34312446b /api-ref | |
| parent | 3aa17e6dc831e7a3d78dfbafc5f924fe3ce15b16 (diff) | |
| download | swift-582460ecf9d503c10fd73c055301634b0b009dbc.tar.gz | |
Document that x-delete-after takes precedence over x-delete-at
Change-Id: Ib2483444d3999e13ba83ca2edd3a8ef8e5c48548
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/parameters.yaml | 27 | ||||
| -rw-r--r-- | api-ref/source/storage-object-services.inc | 6 |
2 files changed, 23 insertions, 10 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 8ab65f58e..425366d04 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -692,18 +692,31 @@ X-Copy-From-Account: type: string X-Delete-After: description: | - The number of seconds after which the system - removes the object. Internally, the Object Storage system stores - this value in the ``X-Delete-At`` metadata item. + The number of seconds after which the system removes the object. The value + should be a positive integer. Internally, the Object Storage system uses + 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 required: false type: integer X-Delete-At: description: | - The 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``. + The 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``. 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 required: false type: integer diff --git a/api-ref/source/storage-object-services.inc b/api-ref/source/storage-object-services.inc index 4c2b45b38..96816997e 100644 --- a/api-ref/source/storage-object-services.inc +++ b/api-ref/source/storage-object-services.inc @@ -130,7 +130,7 @@ Response Parameters - X-Object-Meta-name: X-Object-Meta-name_resp - Content-Disposition: Content-Disposition_resp - Content-Encoding: Content-Encoding_resp - - X-Delete-At: X-Delete-At + - X-Delete-At: X-Delete-At_resp - Accept-Ranges: Accept-Ranges - X-Object-Manifest: X-Object-Manifest_resp - Last-Modified: Last-Modified @@ -602,7 +602,7 @@ Response Parameters - X-Object-Meta-name: X-Object-Meta-name - Content-Disposition: Content-Disposition_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 - Last-Modified: Last-Modified - ETag: ETag_obj_resp @@ -752,9 +752,9 @@ Request - X-Service-Token: X-Service-Token - X-Object-Meta-name: X-Object-Meta-name - X-Delete-At: X-Delete-At + - X-Delete-After: X-Delete-After - Content-Disposition: Content-Disposition - Content-Encoding: Content-Encoding - - X-Delete-After: X-Delete-After - Content-Type: Content-Type_obj_cu_req - X-Trans-Id-Extra: X-Trans-Id-Extra |