18122: Clarify select param behavior in "get collection by pdh" API.
authorTom Clegg <tom@curii.com>
Mon, 20 Sep 2021 13:44:58 +0000 (09:44 -0400)
committerTom Clegg <tom@curii.com>
Mon, 20 Sep 2021 13:44:58 +0000 (09:44 -0400)
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

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

index 6c1cc691c333419e8504c77da50a2fbcc582bda5..01efda2b0c663edcd97d2d3785289be59fb28eeb 100644 (file)
@@ -85,13 +85,13 @@ table(table table-bordered table-condensed).
 
 h3. get
 
-Gets a Collection's metadata by UUID or portable data hash.  When making a request by portable data hash, the returned record will only have the @portable_data_hash@ and @manifest_text@.
+Gets a Collection's metadata by UUID or portable data hash.  When making a request by portable data hash, attributes other than @portable_data_hash@ and @manifest_text@ are not returned, even when requested explicitly using the @select@ parameter.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
+{background:#ccffcc}.|uuid|string|The UUID or portable data hash of the Collection in question.|path||
 
 h3. list