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 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/repositories@
  10
  11 Object type: @s0uqq@
  12
  13 Example UUID: @zzzzz-s0uqq-0123456789abcde@
  14
  15 h2. Resource
  16
  17 The repositories resource lists git repositories managed by Arvados.
  18
  19 Each Repository has, in addition to the "Common resource fields":{{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 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  32
  33 Required arguments are displayed in %{background:#ccffcc}green%.
  34
  35 h3. create
  36
  37 Create a new Repository.
  38
  39 Arguments:
  40
  41 table(table table-bordered table-condensed).
  42 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  43 |repository|object||query||
  44
  45 h3. delete
  46
  47 Delete an existing Repository.
  48
  49 Arguments:
  50
  51 table(table table-bordered table-condensed).
  52 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  53 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  54
  55 h3. get
  56
  57 Gets a Repository's metadata by UUID.
  58
  59 Arguments:
  60
  61 table(table table-bordered table-condensed).
  62 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  63 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  64
  65 h3. get_all_permissions
  66
  67 get_all_permissions repositories
  68
  69 Arguments:
  70
  71 table(table table-bordered table-condensed).
  72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  73
  74 h3. list
  75
  76 List repositories.
  77
  78 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  79
  80 h3. update
  81
  82 Update attributes of an existing Repository.
  83
  84 Arguments:
  85
  86 table(table table-bordered table-condensed).
  87 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  88 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  89 |repository|object||query||