diff options
| author | Christopher Bartz <bartz@dkrz.de> | 2016-12-08 13:42:35 +0100 |
|---|---|---|
| committer | Christopher Bartz <bartz@dkrz.de> | 2017-01-19 16:34:26 +0100 |
| commit | 3934bd606acc2333ee9ae63a40baa35928ef908d (patch) | |
| tree | 1181d58436365ce6d9863866c112f78e6677a081 /doc | |
| parent | aea0585ddbc749b6f4d501430d41b671932c11a4 (diff) | |
| download | python-swiftclient-3934bd606acc2333ee9ae63a40baa35928ef908d.tar.gz | |
prefix-based tempurls support
Implements client-side functionality for
prefix-based tempurls.
Please see: https://review.openstack.org/#/c/274048/
Change-Id: I8d7701daee888ed1120271a96c0660b01543ca2d
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manpages/swift.1 | 4 | ||||
| -rw-r--r-- | doc/source/cli.rst | 7 |
2 files changed, 8 insertions, 3 deletions
diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1 index 5d21c18..b65170c 100644 --- a/doc/manpages/swift.1 +++ b/doc/manpages/swift.1 @@ -134,10 +134,12 @@ programs, such as jq. .RS 4 Generates a temporary URL allowing unauthenticated access to the Swift object at the given path, using the given HTTP method, for the given number of -seconds, using the given TempURL key. If optional \-\-absolute argument is +seconds, using the given TempURL key. With the optional \-\-prefix\-based option a +prefix-based URL is generated. If optional \-\-absolute argument is provided, seconds is instead interpreted as a Unix timestamp at which the URL should expire. \fBExample\fR: tempurl GET $(date \-d "Jan 1 2016" +%s) /v1/AUTH_foo/bar_container/quux.md my_secret_tempurl_key \-\-absolute + .RE \fBauth\fR diff --git a/doc/source/cli.rst b/doc/source/cli.rst index 6c58d11..1f76b05 100644 --- a/doc/source/cli.rst +++ b/doc/source/cli.rst @@ -228,7 +228,7 @@ Capabilities Tempurl ------- - ``tempurl [method] [seconds] [path] [key]`` + ``tempurl [command-options] [method] [seconds] [path] [key]`` Generates a temporary URL for a Swift object. ``method`` option sets an HTTP method to allow for this temporary URL that is usually 'GET' or 'PUT'. ``seconds`` option sets @@ -236,7 +236,10 @@ Tempurl is passed, the Unix timestamp when the temporary URL will expire. ``path`` option sets the full path to the Swift object. Example: ``/v1/AUTH_account/c/o``. ``key`` option is the secret temporary URL key set on the Swift cluster. To set a key, run - ``swift post -m "Temp-URL-Key: <your secret key>"``. + ``swift post -m "Temp-URL-Key: <your secret key>"``. To generate a prefix-based temporary + URL use the ``--prefix-based`` option. This URL will contain the path to the prefix. Do not + forget to append the desired objectname at the end of the path portion (and before the + query portion) before sharing the URL. Auth ---- |