openstack/swift
Code Issues Proposed changes

improve prefix/delimiter api docs

Browse Source 
Change-Id: Ia420ac3f84284eab9d0a371e4d56be6e45994fae
This commit is contained in:
John Dickinson 2018-07-31 14:39:29 -07:00 committed by Kota Tsuyuzaki
parent 6f920fd437
commit 6a2bd0f25d
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
api-ref/source/parameters.yaml
View File

@ -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