X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7e52fd153f2d16f94061ef1eabfe653d4a83852a..5b554bbe0b9104e8a34b87d5570cbf87f0308bce:/doc/api/methods/repositories.html.textile.liquid diff --git a/doc/api/methods/repositories.html.textile.liquid b/doc/api/methods/repositories.html.textile.liquid index 27c98ea56d..7a47da6a3b 100644 --- a/doc/api/methods/repositories.html.textile.liquid +++ b/doc/api/methods/repositories.html.textile.liquid @@ -5,20 +5,23 @@ navmenu: API Methods title: "repositories" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/repositories@ -UUID type: @s0uqq@ +Object type: @s0uqq@ -Required arguments are displayed in %{background:#ccffcc}green%. +Example UUID: @zzzzz-s0uqq-0123456789abcde@ h2. Resource The repositories resource lists git repositories managed by Arvados. -Each Repository has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Each Repository has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| @@ -30,6 +33,10 @@ table(table table-bordered table-condensed). h2. Methods +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. + +Required arguments are displayed in %{background:#ccffcc}green%. + h3. create Create a new Repository. @@ -73,13 +80,7 @@ h3. list List repositories. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of repositories to return.|query|| -|order|string|Order in which to return matching repositories.|query|| -|filters|array|Conditions for filtering repositories.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. update