X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/35336cd73e444534cb2eda20e3730464cc4e6553..ad79a64bd1503e1e47d3849a00b894c4a6bc9810:/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 6f9d142a47..f4eabcfaa8 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. @@ -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,7 @@ 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 - -show collections - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string||path|| +|filters|array|Conditions for filtering collections.|query|| h2. update