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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "repositories"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/repositories@
  12
  13 UUID type: @s0uqq@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 Each Repository has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Attribute|_. Type|_. Description|_. Example|
  23 |name|string|The name of the repository on disk.  Repository names must begin with a letter and contain only alphanumerics.  Unless the repository is owned by the system user, the name must begin with the owner's username, then be separated from the base repository name with @/@.  You may not create a repository that is owned by a user without a username.|@username/project1@|
  24 |clone_urls|array|URLs from which the repository can be cloned. Read-only.|@["git@git.zzzzz.arvadosapi.com:foo/bar.git",
  25  "https://git.zzzzz.arvadosapi.com/foo/bar.git"]@|
  26 |fetch_url|string|URL suggested as a fetch-url in git config. Deprecated. Read-only.||
  27 |push_url|string|URL suggested as a push-url in git config. Deprecated. Read-only.||
  28
  29 h2. Methods
  30
  31 h3. create
  32
  33 Create a new Repository.
  34
  35 Arguments:
  36
  37 table(table table-bordered table-condensed).
  38 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  39 |repository|object||query||
  40
  41 h3. delete
  42
  43 Delete an existing Repository.
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  49 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  50
  51 h3. get
  52
  53 Gets a Repository's metadata by UUID.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  60
  61 h3. get_all_permissions
  62
  63 get_all_permissions repositories
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69
  70 h3. list
  71
  72 List repositories.
  73
  74 Arguments:
  75
  76 table(table table-bordered table-condensed).
  77 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  78 |limit|integer (default 100)|Maximum number of repositories to return.|query||
  79 |order|string|Order in which to return matching repositories.|query||
  80 |filters|array|Conditions for filtering repositories.|query||
  81
  82 h3. update
  83
  84 Update attributes of an existing Repository.
  85
  86 Arguments:
  87
  88 table(table table-bordered table-condensed).
  89 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  90 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  91 |repository|object||query||