diff options
author | John Dickinson <me@not.mn> | 2018-07-31 14:39:29 -0700 |
---|---|---|
committer | Kota Tsuyuzaki <tsuyuzaki.kota@lab.ntt.co.jp> | 2018-08-01 03:10:02 +0000 |
commit | 6a2bd0f25dfd5584be09616cbbf0f0b758a538b3 (patch) | |
tree | 2f71bb2901d5d5b7599c559a78fa6b1c0e9438bd /api-ref | |
parent | 6f920fd4372621e8ca06eb5cdc07a6f399b0d2db (diff) | |
download | swift-6a2bd0f25dfd5584be09616cbbf0f0b758a538b3.tar.gz |
improve prefix/delimiter api docs
Change-Id: Ia420ac3f84284eab9d0a371e4d56be6e45994fae
Diffstat (limited to 'api-ref')
-rw-r--r-- | api-ref/source/parameters.yaml | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 95215a9f8..b3ae63d0f 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -1003,11 +1003,10 @@ bulk-delete: type: string delimiter: description: | - Delimiter value, which returns the object names - that are nested in the container. If you do not set a prefix and - set the delimiter to "/" you may get unexpected results where all - the objects are returned instead of only those with the delimiter - set. + The delimiter is a single character used to split object + names to present a pseudo-directory hierarchy of objects. When combined + with a ``prefix`` query, this enables API users to simulate and + traverse the objects in a container as if they were in a directory tree. in: query required: false type: string @@ -1116,14 +1115,16 @@ multipart-manifest_put: path: description: | For a string value, returns the object names that - are nested in the pseudo path. + are nested in the pseudo path. Please use ``prefix``/``delimiter`` + queries instead of using this ``path`` query. in: query required: false type: string prefix: description: | - Prefix value. Named items in the response begin - with this value. + Only objects with this prefix will be returned. When combined with a + ``delimiter`` query, this enables API users to simulate and + traverse the objects in a container as if they were in a directory tree. in: query required: false type: string |