X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/61ddcaf192e3f39ed8a1242f35bf1b28ff1fe121..refs/heads/10036-canceled-container-state:/doc/api/methods/collections.html.textile.liquid diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid index 7f522c9639..f5e685e2e9 100644 --- a/doc/api/methods/collections.html.textile.liquid +++ b/doc/api/methods/collections.html.textile.liquid @@ -6,11 +6,12 @@ title: "collections" ... +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/collections@ Required arguments are displayed in %{background:#ccffcc}green%. - h2. create Create a new Collection. @@ -31,16 +32,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path|| -h2. destroy - -destroy collections - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| - h2. get Gets a Collection's metadata by UUID. @@ -62,16 +53,9 @@ table(table table-bordered table-condensed). |limit|integer (default 100)|Maximum number of collections to return.|query|| |order|string|Order in which to return matching collections.|query|| |filters|array|Conditions for filtering collections.|query|| +|select|array|Data fields to return in the result list.|query|@["uuid", "manifest_text"]@| -h2. show - -show collections - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in results by default. If you need it, pass a @select@ parameter that includes @manifest_text@. h2. update