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 {% include 'notebox_begin_warning' %}
  15 This is a legacy API.  This endpoint is deprecated, disabled by default in new installations, and slated to be removed entirely in a future major release of Arvados.  It is replaced by "collection versioning.":collections.html
  16 {% include 'notebox_end' %}
  17
  18 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/repositories@
  19
  20 Object type: @s0uqq@
  21
  22 Example UUID: @zzzzz-s0uqq-0123456789abcde@
  23
  24 h2. Resource
  25
  26 The repositories resource lists git repositories managed by Arvados.
  27
  28 Each Repository has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Attribute|_. Type|_. Description|_. Example|
  32 |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@|
  33 |clone_urls|array|URLs from which the repository can be cloned. Read-only.|@["git@git.zzzzz.arvadosapi.com:foo/bar.git",
  34  "https://git.zzzzz.arvadosapi.com/foo/bar.git"]@|
  35 |fetch_url|string|URL suggested as a fetch-url in git config. Deprecated. Read-only.||
  36 |push_url|string|URL suggested as a push-url in git config. Deprecated. Read-only.||
  37
  38 h2. Methods
  39
  40 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  41
  42 Required arguments are displayed in %{background:#ccffcc}green%.
  43
  44 h3. create
  45
  46 Create a new Repository.
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 |repository|object||query||
  53
  54 h3. delete
  55
  56 Delete an existing Repository.
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  63
  64 h3. get
  65
  66 Gets a Repository's metadata by UUID.
  67
  68 Arguments:
  69
  70 table(table table-bordered table-condensed).
  71 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  72 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  73
  74 h3. get_all_permissions
  75
  76 get_all_permissions repositories
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82
  83 h3. list
  84
  85 List repositories.
  86
  87 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  88
  89 h3. update
  90
  91 Update attributes of an existing Repository.
  92
  93 Arguments:
  94
  95 table(table table-bordered table-condensed).
  96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  97 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  98 |repository|object||query||