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
  10
  11 Required arguments are displayed in %{background:#ccffcc}green%.
  12
  13
  14 h2. create
  15
  16 Create a new Repository.
  17
  18 Arguments:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  22 |repository|object||query||
  23
  24 h2. delete
  25
  26 Delete an existing Repository.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  33
  34 h2. destroy
  35
  36 destroy repositories
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string||path||
  43
  44 h2. get
  45
  46 Gets a Repository's metadata by UUID.
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 {background:#ccffcc}.|uuid|string|The UUID of the Repository in question.|path||
  53
  54 h2. get_all_permissions
  55
  56 get_all_permissions repositories
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62
  63 h2. list
  64
  65 List repositories.
  66
  67 Arguments:
  68
  69 table(table table-bordered table-condensed).
  70 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  71 |limit|integer (default 100)|Maximum number of repositories to return.|query||
  72 |order|string|Order in which to return matching repositories.|query||
  73 |filters|array|Conditions for filtering repositories.|query||
  74
  75 h2. show
  76
  77 show repositories
  78
  79 Arguments:
  80
  81 table(table table-bordered table-condensed).
  82 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  83 {background:#ccffcc}.|uuid|string||path||
  84
  85 h2. 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||