index.html 38.6 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8
<!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 -->

Spiros Koulouzis's avatar
Spiros Koulouzis committed
9
  <title>drip-api</title>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
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

  <!-- 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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
38
        <a class="navbar-brand" href="index.html">drip-api</a>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
39 40 41
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
42
          <li><a href="resources.html">Resources</a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
43 44 45 46 47 48 49 50 51 52 53
          <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">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
54
          <li><a href="#resources">Resources</a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
55 56 57 58 59 60 61 62 63 64 65 66 67
          <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">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
68
    <h1>drip-api</h1>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
69 70
  </div>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
  <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_AnsibleOutputController.html">
      <td>  <span class="resource-name">AnsibleOutputController</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
91
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/deployer/ansible/</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/ansible/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/ansible/commands</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/ansible/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/ansible/{id}</span>
</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">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">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 showing the output from ansible executions</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_BenchmarkController.html">
      <td>  <span class="resource-name">BenchmarkController</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
109
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/benchmark/</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/benchmark/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/benchmark/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/benchmark/{id}</span>
</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">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">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 cloud benchmark tests like
sysbench</span>
</td>
    </tr>
    <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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
139
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/credentials/cloud/sample</span>
</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> 
</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">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>
</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>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_DeployController.html">
      <td>  <span class="resource-name">DeployController</span>
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/deployer/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/deploy</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/sample</span>
184
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/scale</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
185 186 187 188 189 190
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/deployer/{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">POST</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> 
191
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
Spiros Koulouzis's avatar
Spiros Koulouzis committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
</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>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_KeyPairController.html">
      <td>  <span class="resource-name">KeyPairController</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
214
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/keys/</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
</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/{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">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>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_PlannerController.html">
      <td>  <span class="resource-name">PlannerController</span>
</td>
      <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>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/plan/</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/vereify_plan</span>
</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/post/{name}</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/tosca/{id}</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/planner/post/{level}/{name}/{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><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">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 planing the type of resources to be
provisopned based on a TOSCA description.</span>
</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>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/provisioner/all</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/ids</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/provision</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/sample</span>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/{id}</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
277
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/provisioner/post/provision</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
278 279 280 281 282 283
</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">GET</span> 
</samp></li><li><samp>  <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> 
Spiros Koulouzis's avatar
Spiros Koulouzis committed
284
</samp></li><li><samp>  <span class="label label-default resource-method">POST</span> 
Spiros Koulouzis's avatar
Spiros Koulouzis committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
</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>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_ScriptController.html">
      <td>  <span class="resource-name">ScriptController</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
306
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  <span class="resource-path">/user/v1.0/script/</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
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 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
</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>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_ToscaController.html">
      <td>  <span class="resource-name">ToscaController</span>
</td>
      <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>
</samp></li><li><samp>  <span class="resource-path">/user/v1.0/tosca/post</span>
</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>
      <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 TOSCA descriptions that can be
used by the planner.</span>
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_UserController.html">
      <td>  <span class="resource-name">UserController</span>
</td>
      <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>
</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>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
  <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_AnsibleOutput.html">
      <td>  <span class="datatype-name">AnsibleOutput</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
412 413
      <td>  <span class="datatype-description">This class represents the the ansible out put for a specific VM. This can be
used as a archive / log of ansible executions</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
414 415 416 417 418
</td>
    </tr>
    <tr class="clickable-row" data-href="json_AnsibleResult.html">
      <td>  <span class="datatype-name">AnsibleResult</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
419 420 421
      <td>  <span class="datatype-description">This class represents an ansible execution result. This can be used as a
archive / log of ansible executions for example how much time it took for
execution, errors etc.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
422 423 424 425 426
</td>
    </tr>
    <tr class="clickable-row" data-href="json_BenchmarkResult.html">
      <td>  <span class="datatype-name">BenchmarkResult</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
427 428
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
429 430 431 432 433
</td>
    </tr>
    <tr class="clickable-row" data-href="json_CloudCredentials.html">
      <td>  <span class="datatype-name">CloudCredentials</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
434 435
      <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
Spiros Koulouzis committed
436 437 438 439 440
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployParameter.html">
      <td>  <span class="datatype-name">DeployParameter</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
441 442 443
      <td>  <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
444 445 446 447 448
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployRequest.html">
      <td>  <span class="datatype-name">DeployRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
449 450
      <td>  <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
451 452 453 454 455
</td>
    </tr>
    <tr class="clickable-row" data-href="json_DeployResponse.html">
      <td>  <span class="datatype-name">DeployResponse</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
456 457 458
      <td>  <span class="datatype-description">This class represents the response of a deploy request. It may hold a key
pair used for logging in and managing a docker cluster. Currently they key
pair is only used by kubernetes</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
459 460 461 462 463
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Key.html">
      <td>  <span class="datatype-name">Key</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
464 465 466
      <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
Spiros Koulouzis committed
467 468 469 470 471
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyPair.html">
      <td>  <span class="datatype-name">KeyPair</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
472 473
      <td>  <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for
logging in VMs.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
474 475 476 477 478
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyType.html">
      <td>  <span class="datatype-name">KeyType</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
479
      <td>  <span class="datatype-description">This enu specifies if a key is private or public</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
480 481 482 483 484
</td>
    </tr>
    <tr class="clickable-row" data-href="json_KeyValueHolder.html">
      <td>  <span class="datatype-name">KeyValueHolder</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
485 486
      <td>  <span class="datatype-description">This is a generic class that hold key-value pairs. It's main usage is to hold
abstract types such as TOSCA.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
487 488 489 490 491
</td>
    </tr>
    <tr class="clickable-row" data-href="json_OwnedObject.html">
      <td>  <span class="datatype-name">OwnedObject</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
492 493
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
494 495 496 497 498
</td>
    </tr>
    <tr class="clickable-row" data-href="json_PlanRequest.html">
      <td>  <span class="datatype-name">PlanRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
499
      <td>  <span class="datatype-description">This class represents a plan request sent to the planner.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
500 501 502 503 504
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ProvisionRequest.html">
      <td>  <span class="datatype-name">ProvisionRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
505 506
      <td>  <span class="datatype-description">This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
507 508 509 510 511
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ProvisionResponse.html">
      <td>  <span class="datatype-name">ProvisionResponse</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
512
      <td>  <span class="datatype-description">This class represents a description of provisioned resources</span>
513 514 515 516 517 518 519
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ScaleDeploymetRequest.html">
      <td>  <span class="datatype-name">ScaleDeploymetRequest</span>
</td>
      <td>  <span class="datatype-description">This class represents a scale request for a deployment. At the moment we only
support swarm.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
520 521 522 523 524
</td>
    </tr>
    <tr class="clickable-row" data-href="json_Script.html">
      <td>  <span class="datatype-name">Script</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
525
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
526 527 528 529 530
</td>
    </tr>
    <tr class="clickable-row" data-href="json_User.html">
      <td>  <span class="datatype-name">User</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
531
      <td>  <span class="datatype-description">This class represents a user.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
</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>
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_plan.html">
      <td>  <span class="datatype-name">plan</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
593
      <td>  <span class="datatype-description">This class represents a plan to be provided to the planner.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
</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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
612 613 614 615 616
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_cloudCredentials.html">
      <td>  <span class="datatype-name">cloudCredentials</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
617 618
      <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
Spiros Koulouzis committed
619 620 621 622 623
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployParameter.html">
      <td>  <span class="datatype-name">deployParameter</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
624 625 626
      <td>  <span class="datatype-description">This class is used by the deployer to deploy software
(swarm,kubernetes,ansible). It is generated by the provisioner to contain VM
information.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
627 628 629 630 631
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployRequest.html">
      <td>  <span class="datatype-name">deployRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
632 633
      <td>  <span class="datatype-description">This class holds the necessary POJO IDs to request the deployment of a
software</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
634 635 636 637 638
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_deployResponse.html">
      <td>  <span class="datatype-name">deployResponse</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
639 640 641
      <td>  <span class="datatype-description">This class represents the response of a deploy request. It may hold a key
pair used for logging in and managing a docker cluster. Currently they key
pair is only used by kubernetes</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
642 643 644 645 646
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_key.html">
      <td>  <span class="datatype-name">key</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
647 648 649
      <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
Spiros Koulouzis committed
650 651 652 653 654
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyType.html">
      <td>  <span class="datatype-name">keyType</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
655
      <td>  <span class="datatype-description">This enu specifies if a key is private or public</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
656 657 658 659 660
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyPair.html">
      <td>  <span class="datatype-name">keyPair</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
661 662
      <td>  <span class="datatype-description">This class hold the pair of public private keys. The keys may be used for
logging in VMs.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
663 664 665 666 667
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_keyValueHolder.html">
      <td>  <span class="datatype-name">keyValueHolder</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
668 669
      <td>  <span class="datatype-description">This is a generic class that hold key-value pairs. It's main usage is to hold
abstract types such as TOSCA.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
670 671 672 673 674
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_ownedObject.html">
      <td>  <span class="datatype-name">ownedObject</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
675 676
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
677 678 679 680 681
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_planRequest.html">
      <td>  <span class="datatype-name">planRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
682
      <td>  <span class="datatype-description">This class represents a plan request sent to the planner.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
683 684 685 686 687
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionRequest.html">
      <td>  <span class="datatype-name">provisionRequest</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
688 689
      <td>  <span class="datatype-description">This class is a holder for the the object IDs that are required by the
provisioner to request for cloud resources.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
690 691 692 693 694
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_provisionResponse.html">
      <td>  <span class="datatype-name">provisionResponse</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
695
      <td>  <span class="datatype-description">This class represents a description of provisioned resources</span>
696 697 698 699 700 701 702
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_scaleDeploymetRequest.html">
      <td>  <span class="datatype-name">scaleDeploymetRequest</span>
</td>
      <td>  <span class="datatype-description">This class represents a scale request for a deployment. At the moment we only
support swarm.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
703 704 705 706 707
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_script.html">
      <td>  <span class="datatype-name">script</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
708
      <td>  <span class="datatype-description">This class represents a simple script that can run on a provisioned VM.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
709 710 711 712 713
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_user.html">
      <td>  <span class="datatype-name">user</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
714
      <td>  <span class="datatype-description">This class represents a user.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
715 716 717 718 719
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_ansibleOutput.html">
      <td>  <span class="datatype-name">ansibleOutput</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
720 721
      <td>  <span class="datatype-description">This class represents the the ansible out put for a specific VM. This can be
used as a archive / log of ansible executions</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
722 723 724 725 726
</td>
    </tr>
    <tr class="clickable-row" data-href="xml_ns0_benchmarkResult.html">
      <td>  <span class="datatype-name">benchmarkResult</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
727 728
      <td>  <span class="datatype-description">This is the base class for users to own resources. Many classes extend this
class</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
</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>