X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b54d7820e899733ce10b8960b1f04d0481f2e11f..41887dd213cfa165925e94d4f3bb120edeb1a30d:/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 9c631c2140..8760fe88ed 100644 --- a/doc/api/methods/collections.html.textile.liquid +++ b/doc/api/methods/collections.html.textile.liquid @@ -6,10 +6,11 @@ title: "collections" ... -h1. collections +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html -Required arguments are displayed in %{background:#ccffcc}green%. +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/collections@ +Required arguments are displayed in %{background:#ccffcc}green%. h2. create @@ -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. @@ -51,17 +42,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. index - -index collections - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List collections. @@ -72,19 +52,10 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of collections to return.|query|| |order|string|Order in which to return matching collections.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching collections.|query|| -|where|object|Conditions for filtering collections.|query|| - -h2. show +|filters|array|Conditions for filtering collections.|query|| +|select|array|Data fields to return in the result list.|query|@["uuid", "manifest_text"]@| -show collections - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +N.B.: 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