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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "repositories"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/repositories@
  15
  16 Object type: @s0uqq@
  17
  18 Example UUID: @zzzzz-s0uqq-0123456789abcde@
  19
  20 h2. Resource
  21
  22 The repositories resource lists git repositories managed by Arvados.
  23
  24 Each Repository has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Example|
  28 |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@|
  29 |clone_urls|array|URLs from which the repository can be cloned. Read-only.|@["git@git.zzzzz.arvadosapi.com:foo/bar.git",
  30  "https://git.zzzzz.arvadosapi.com/foo/bar.git"]@|
  31 |fetch_url|string|URL suggested as a fetch-url in git config. Deprecated. Read-only.||
  32 |push_url|string|URL suggested as a push-url in git config. Deprecated. Read-only.||
  33
  34 h2. Methods
  35
  36 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  37
  38 Required arguments are displayed in %{background:#ccffcc}green%.
  39
  40 h3. create
  41
  42 Create a new Repository.
  43
  44 Arguments:
  45
  46 table(table table-bordered table-condensed).
  47 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  48 |repository|object||query||
  49
  50 h3. delete
  51
  52 Delete an existing Repository.
  53
  54 Arguments:
  55
  56 table(table table-bordered table-condensed).
  57 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  58 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  59
  60 h3. get
  61
  62 Gets a Repository's metadata by UUID.
  63
  64 Arguments:
  65
  66 table(table table-bordered table-condensed).
  67 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  68 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  69
  70 h3. get_all_permissions
  71
  72 get_all_permissions repositories
  73
  74 Arguments:
  75
  76 table(table table-bordered table-condensed).
  77 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  78
  79 h3. list
  80
  81 List repositories.
  82
  83 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  84
  85 h3. update
  86
  87 Update attributes of an existing Repository.
  88
  89 Arguments:
  90
  91 table(table table-bordered table-condensed).
  92 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  93 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  94 |repository|object||query||