20527: Document the select argument of the groups contents API method 20527-group-contents-select-doc
authorBrett Smith <brett.smith@curii.com>
Fri, 19 May 2023 14:39:03 +0000 (10:39 -0400)
committerBrett Smith <brett.smith@curii.com>
Fri, 19 May 2023 14:39:03 +0000 (10:39 -0400)
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

doc/api/methods/groups.html.textile.liquid

index af14c56f40e26a2783343851955441c78a8ae24e..02e8bfbb3f3d9f75c7237a7918526e6554eb6b98 100644 (file)
@@ -116,6 +116,7 @@ table(table table-bordered table-condensed).
 |include|string|If provided with the value "owner_uuid", this will return owner objects in the "included" field of the response.|query||
 |include_trash|boolean (default false)|Include trashed objects.|query|@true@|
 |include_old_versions|boolean (default false)|Include past versions of the collections being listed.|query|@true@|
+|select|array|Attributes of each object to return in the response. Specify an unqualified name like @uuid@ to select that attribute on all object types, or a qualified name like @collections.name@ to select that attribute on objects of the specified type. By default, all available attributes are returned, except on collections, where @manifest_text@ is not returned and cannot be selected due to an implementation limitation. This limitation may be removed in the future.|query|@["uuid", "collections.name"]@|
 
 Notes: