Skip to content

C
CONF
Switch branch/tag
Find file
Normal viewHistoryPermalink
index.html 31.7 KB
Newer Older
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>drip-api</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">drip-api</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
          <li><a href="#resources">Resources</a></li>
          <li><a href="#syntax_json">JSON</a></li>
          <li><a href="#syntax_xml">XML</a></li>
          <li class="divider"></li>
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="dropdown"><a href="index.html">Home</a></li>
        </ol>

  <div class="page-header">
    <h1>drip-api</h1>
  </div>

  <h1 class="page-header" id="resources">Resources</h1>

  <p>
    The resources use a data model that is supported by a set of client-side libraries that are made available on the
    <a href="downloads.html">files and libraries</a> page.
  </p>

  <table class="table table-hover resources">
    <thead>
    <tr>
      <th align="center">name</th>
      <th align="center">path</th>
      <th align="center">methods</th>
      <th align="center">description</th>
    </tr>
    </thead>
    <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="resource_CloudConfigurationController0.html">
      <td>  <span class="resource-name">CloudConfigurationController0</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v0.0/switch/account/configure/ec2</span>
</samp></li><li><samp>  <span class="resource-path">/user/v0.0/switch/account/configure/geni</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling cloud credentials used by the
provisoner to request for resources (VMs).</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_CloudCredentialsController.html">
      <td>  <span class="resource-name">CloudCredentialsController</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud</span>
Spiros Koulouzis's avatar
Cleanup
c5a34698
 
Spiros Koulouzis committed
105 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/all</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
106 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/ids</span>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
107 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/sample</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
108 109 110 111 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/{id}</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/upload/{id}</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span>
Spiros Koulouzis's avatar
Cleanup
c5a34698
 
Spiros Koulouzis committed
112 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
113 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
114 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
115 116 117 118 119 120 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling CloudCredentials.
CloudCredentials are a represntation of the credentials that are used by the
provisoner to request for resources (VMs)</span>
Spiros Koulouzis's avatar
changed controller name to configure controller
8991bf18
 
Spiros Koulouzis committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_ConfigurationController.html">
      <td>  <span class="resource-name">ConfigurationController</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/deployer/configuration/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/configuration/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/configuration/post</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/configuration/upload</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/configuration/{id}</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">DELETE</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for storing PlayBook descriptions that can be
used by the planner.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
140 141 142 143 144 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_DeployController.html">
      <td>  <span class="resource-name">DeployController</span>
</td>
Spiros Koulouzis's avatar
Added delete all
e9419be6
 
Spiros Koulouzis committed
145 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/deployer/all</span>
Spiros Koulouzis's avatar
changed controller name to configure controller
8991bf18
 
Spiros Koulouzis committed
146 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/deploy</span>
Spiros Koulouzis's avatar
Added delete all
e9419be6
 
Spiros Koulouzis committed
147 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/ids</span>
Spiros Koulouzis's avatar
changed controller name to configure controller
8991bf18
 
Spiros Koulouzis committed
148 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/sample</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
149 150 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/{id}</span>
</samp></li></ul></td>
Spiros Koulouzis's avatar
Added delete all
e9419be6
 
Spiros Koulouzis committed
151 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">DELETE</span>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
152 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span>
Spiros Koulouzis's avatar
Added delete all
e9419be6
 
Spiros Koulouzis committed
153 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
changed controller name to configure controller
8991bf18
 
Spiros Koulouzis committed
154 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for deploying a cluster on provisoned
resources.</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_DeployController0.html">
      <td>  <span class="resource-name">DeployController0</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v0.0/switch/deploy/kubernetes</span>
</samp></li><li><samp>  <span class="resource-path">/user/v0.0/switch/deploy/swarm</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for deploying a cluster on provisoned
resources.</span>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
172 173 174 175 176 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_KeysController.html">
      <td>  <span class="resource-name">KeysController</span>
</td>
Spiros Koulouzis's avatar
changed controller name to configure controller
8991bf18
 
Spiros Koulouzis committed
177 178 179 180 181 182 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/keys</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/keys/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/keys/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/keys/sample</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/keys/upload</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/keys/{id}</span>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
183 184 185 186 187 188 189 190 191 192 193 
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling user public keys. These keys can
be used by the provisoner to allow the user to login to the VMs from the
machine the keys correspond to.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
194 195 196 197 198 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_PlannerController.html">
      <td>  <span class="resource-name">PlannerController</span>
</td>
Spiros Koulouzis's avatar
Added delete all
fd2b529b
 
Spiros Koulouzis committed
199 200 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/planner/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/ids</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
201 202 203 204 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/{id}</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/plan/{tosca_id}</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/tosca/{id}</span>
</samp></li></ul></td>
Spiros Koulouzis's avatar
Added delete all
fd2b529b
 
Spiros Koulouzis committed
205 206 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">DELETE</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
207 208 209 210 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
Spiros Koulouzis's avatar
Added delete all
fd2b529b
 
Spiros Koulouzis committed
211 212 
      <td>  <span class="resource-description">This controller is responsible for planing the type of resources to be
provisopned based on a TOSCA description.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_PlannerController0.html">
      <td>  <span class="resource-name">PlannerController0</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v0.0/switch/plan/planning</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for planing the type of resources to be
provisopned based on a TOSCA description.</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_ProvisionController.html">
      <td>  <span class="resource-name">ProvisionController</span>
</td>
Spiros Koulouzis's avatar
Cleanup
c5a34698
 
Spiros Koulouzis committed
229 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/provisioner/all</span>
Spiros Koulouzis's avatar
Added delete all
e9419be6
 
Spiros Koulouzis committed
230 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/ids</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
231 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/provision</span>
Spiros Koulouzis's avatar
Fix EC2.conf mapping
504e1228
 
Spiros Koulouzis committed
232 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/sample</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
233 234 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/{id}</span>
</samp></li></ul></td>
Spiros Koulouzis's avatar
Added delete all
e9419be6
 
Spiros Koulouzis committed
235 236 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">DELETE</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
237 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span>
Spiros Koulouzis's avatar
Fix EC2.conf mapping
504e1228
 
Spiros Koulouzis committed
238 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for obtaining resources from cloud providers
based the plan generated by the planner</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_ProvisionController0.html">
      <td>  <span class="resource-name">ProvisionController0</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v0.0/switch/provision/execute</span>
</samp></li><li><samp>  <span class="resource-path">/user/v0.0/switch/provision/upload</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for obtaining resources from cloud providers
based the plan generated by the planner and uploaded by the user</span>
Spiros Koulouzis's avatar
Fix EC2.conf mapping
504e1228
 
Spiros Koulouzis committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_ScriptController.html">
      <td>  <span class="resource-name">ScriptController</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/script</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/script/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/script/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/script/sample</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/script/upload</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/script/{id}</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling user scripts. These user can be
used by the provisoner to run on the created VMs.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
277 278 279 280 281 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_ToscaController.html">
      <td>  <span class="resource-name">ToscaController</span>
</td>
Spiros Koulouzis's avatar
Added delete all
fd2b529b
 
Spiros Koulouzis committed
282 283 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/tosca/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/tosca/ids</span>
Spiros Koulouzis's avatar
allow tosca post string
0ba94a06
 
Spiros Koulouzis committed
284 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/tosca/post</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
285 286 287 
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/tosca/upload</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/tosca/{id}</span>
</samp></li></ul></td>
Spiros Koulouzis's avatar
Added delete all
fd2b529b
 
Spiros Koulouzis committed
288 289 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">DELETE</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
290 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span>
Spiros Koulouzis's avatar
allow tosca post string
0ba94a06
 
Spiros Koulouzis committed
291 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
292 293 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
Spiros Koulouzis's avatar
Fixed name bug
624a3dbd
 
Spiros Koulouzis committed
294 295 
      <td>  <span class="resource-description">This controller is responsible for storing TOSCA descriptions that can be
used by the planner.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
296 297 298 299 300 
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_UserController.html">
      <td>  <span class="resource-name">UserController</span>
</td>
Spiros Koulouzis's avatar
Fixed name bug
624a3dbd
 
Spiros Koulouzis committed
301 302 303 304 305 
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/manager/v1.0/user/all</span>
</samp></li><li><samp>  <span class="resource-path">/manager/v1.0/user/ids</span>
</samp></li><li><samp>  <span class="resource-path">/manager/v1.0/user/modify</span>
</samp></li><li><samp>  <span class="resource-path">/manager/v1.0/user/register</span>
</samp></li><li><samp>  <span class="resource-path">/manager/v1.0/user/{id}</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling user accounts</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_UserController0.html">
      <td>  <span class="resource-name">UserController0</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/manager/v0.0/switch/account/register</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling user accounts</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_UserPublicKeysController0.html">
      <td>  <span class="resource-name">UserPublicKeysController0</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v0.0/switch/provision/confuserkey</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling user public keys. These keys can
be used by the provisoner to allow the user to login to the VMs from the
machine the keys correspond to.</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_UserScriptController0.html">
      <td>  <span class="resource-name">UserScriptController0</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v0.0/switch/provision/confscript</span>
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="label label-default resource-method">POST</span> 
</samp></li></ul></td>
      <td>  <span class="resource-description">This controller is responsible for handling user scripts. These user can be
used by the provisoner to run on the created VMs.</span>
</td>
    </tr>
    </tbody>
  </table>

  <h1 class="page-header" id="data">Data Types</h1>

  <h3 id="syntax_json"><span class="syntax-name">JSON</span></h3>

  <table class="table table-hover datatypes">
    <thead>
      <tr>
        <th align="center">type</th>
        <th align="center">description</th>
      </tr>
    </thead>
    <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="json_CloudCredentials.html">
      <td>  <span class="datatype-name">CloudCredentials</span>
</td>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
367 368 
      <td>  <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
Spiros Koulouzis's avatar
Fix EC2.conf mapping
504e1228
 
Spiros Koulouzis committed
369 370 371 372 373 374 
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployParameter.html">
      <td>  <span class="datatype-name">DeployParameter</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
375 376 
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
377 378 
    <tr class="clickable-row" data-href="json_DeployRequest.html">
      <td>  <span class="datatype-name">DeployRequest</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
379 
</td>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
380 
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
381 382 
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
383 384 
    <tr class="clickable-row" data-href="json_DeployResponse.html">
      <td>  <span class="datatype-name">DeployResponse</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
385 386 387 388 
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
389 390 
    <tr class="clickable-row" data-href="json_Key.html">
      <td>  <span class="datatype-name">Key</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
391 
</td>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
392 393 394 
      <td>  <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
395 396 
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
397 398 
    <tr class="clickable-row" data-href="json_KeyValueHolder.html">
      <td>  <span class="datatype-name">KeyValueHolder</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
399 
</td>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
400 
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
401 402 403 404 405 406 407 408 
</td>
    </tr>
    <tr class="clickable-row" data-href="json_OwnedObject.html">
      <td>  <span class="datatype-name">OwnedObject</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
409 410 
    <tr class="clickable-row" data-href="json_PlanResponse.html">
      <td>  <span class="datatype-name">PlanResponse</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
411 412 
</td>
      <td>  <span class="datatype-description">This class represents a plan generated by the planner.</span>
Spiros Koulouzis's avatar
Added playbook controller, service , POJO, DAO
a4b4b101
 
Spiros Koulouzis committed
413 414 415 416 417 418 
</td>
    </tr>
    <tr class="clickable-row" data-href="json_PlaybookRepresentation.html">
      <td>  <span class="datatype-name">PlaybookRepresentation</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
419 420 
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
421 422 423 424 425 426 427 428 
    <tr class="clickable-row" data-href="json_ProvisionRequest.html">
      <td>  <span class="datatype-name">ProvisionRequest</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ProvisionResponse.html">
      <td>  <span class="datatype-name">ProvisionResponse</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Script.html">
      <td>  <span class="datatype-name">Script</span>
</td>
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ToscaRepresentation.html">
      <td>  <span class="datatype-name">ToscaRepresentation</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Type.html">
      <td>  <span class="datatype-name">Type</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="json_User.html">
      <td>  <span class="datatype-name">User</span>
</td>
      <td>  <span class="datatype-description">This class represents a user.</span>
</td>
    </tr>
    </tbody>
  </table>

  <h3 id="syntax_xml"><span class="syntax-name">XML</span></h3>

  <table class="table table-hover datatypes">
    <caption>Default Namespace  (<a href="ns0.xsd">schema</a>)</caption>
    <thead>
      <tr>
        <th align="center">type</th>
        <th align="center">description</th>
      </tr>
    </thead>
    <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="xml_ns0_attribute.html">
      <td>  <span class="datatype-name">attribute</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_confScript.html">
      <td>  <span class="datatype-name">confScript</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_confUserKey.html">
      <td>  <span class="datatype-name">confUserKey</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_configure.html">
      <td>  <span class="datatype-name">configure</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deploy.html">
      <td>  <span class="datatype-name">deploy</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_execute.html">
      <td>  <span class="datatype-name">execute</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_loginKey0.html">
      <td>  <span class="datatype-name">loginKey0</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Added delete all
fd2b529b
 
Spiros Koulouzis committed
511 512 513 514 515 516 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_plan.html">
      <td>  <span class="datatype-name">plan</span>
</td>
      <td>  <span class="datatype-description">This class represents a plan to be provided to the planner.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_register.html">
      <td>  <span class="datatype-name">register</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_result.html">
      <td>  <span class="datatype-name">result</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_upload.html">
      <td>  <span class="datatype-name">upload</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_cloudCredentials.html">
      <td>  <span class="datatype-name">cloudCredentials</span>
</td>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
540 541 
      <td>  <span class="datatype-description">This class represents the cloud credentials. They are used by the provisoner
to request for resources.</span>
Spiros Koulouzis's avatar
Fix EC2.conf mapping
504e1228
 
Spiros Koulouzis committed
542 543 544 545 546 547 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
      <td>  <span class="datatype-name">deployParameter</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
548 549 
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
550 551 
    <tr class="clickable-row" data-href="xml_ns0_deployRequest.html">
      <td>  <span class="datatype-name">deployRequest</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
552 553 554 555 
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
556 557 
    <tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
      <td>  <span class="datatype-name">deployResponse</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
558 559 560 561 
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
562 563 
    <tr class="clickable-row" data-href="xml_ns0_key.html">
      <td>  <span class="datatype-name">key</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
564 
</td>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
565 566 567 
      <td>  <span class="datatype-description">This class represents a key. This key can be used to either login to a VM
created by the provisiner or by the VM to allow the user to login to the VMs
from the machine the keys correspond to.</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
568 569 570 571 572 573 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_type.html">
      <td>  <span class="datatype-name">type</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
574 575 576 577 578 579 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
      <td>  <span class="datatype-name">keyValueHolder</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
580 581 582 583 584 585 586 587 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
      <td>  <span class="datatype-name">ownedObject</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
588 589 590 591 
    <tr class="clickable-row" data-href="xml_ns0_planResponse.html">
      <td>  <span class="datatype-name">planResponse</span>
</td>
      <td>  <span class="datatype-description">This class represents a plan generated by the planner.</span>
Spiros Koulouzis's avatar
Added playbook controller, service , POJO, DAO
a4b4b101
 
Spiros Koulouzis committed
592 593 594 595 596 597 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_playbookRepresentation.html">
      <td>  <span class="datatype-name">playbookRepresentation</span>
</td>
      <td>  <span class="datatype-description"></span>
Spiros Koulouzis's avatar
refactor API
5d404579
 
Spiros Koulouzis committed
598 599 600 601 602 603 604 605 606 607 
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionRequest.html">
      <td>  <span class="datatype-name">provisionRequest</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionResponse.html">
      <td>  <span class="datatype-name">provisionResponse</span>
Spiros Koulouzis's avatar
Moved doc location
f76a35e4
 
Spiros Koulouzis committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_script.html">
      <td>  <span class="datatype-name">script</span>
</td>
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_toscaRepresentation.html">
      <td>  <span class="datatype-name">toscaRepresentation</span>
</td>
      <td>  <span class="datatype-description"></span>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_user.html">
      <td>  <span class="datatype-name">user</span>
</td>
      <td>  <span class="datatype-description">This class represents a user.</span>
</td>
    </tr>
    </tbody>
  </table>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>