foreman_api 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. data/README.rdoc +35 -18
  2. data/doc/ForemanApi/Resources/Architecture.html +93 -136
  3. data/doc/ForemanApi/Resources/Audit.html +42 -60
  4. data/doc/ForemanApi/Resources/AuthSourceLdap.html +129 -190
  5. data/doc/ForemanApi/Resources/Bookmark.html +97 -142
  6. data/doc/ForemanApi/Resources/CommonParameter.html +93 -136
  7. data/doc/ForemanApi/Resources/ComputeResource.html +131 -190
  8. data/doc/ForemanApi/Resources/ConfigTemplate.html +145 -211
  9. data/doc/ForemanApi/Resources/Dashboard.html +21 -29
  10. data/doc/ForemanApi/Resources/Domain.html +103 -151
  11. data/doc/ForemanApi/Resources/Environment.html +89 -130
  12. data/doc/ForemanApi/Resources/FactValue.html +29 -41
  13. data/doc/ForemanApi/Resources/Home.html +32 -45
  14. data/doc/ForemanApi/Resources/Host.html +317 -251
  15. data/doc/ForemanApi/Resources/HostClass.html +55 -79
  16. data/doc/ForemanApi/Resources/Hostgroup.html +125 -184
  17. data/doc/ForemanApi/Resources/HostgroupClass.html +57 -82
  18. data/doc/ForemanApi/Resources/Image.html +109 -160
  19. data/doc/ForemanApi/Resources/Location.html +937 -0
  20. data/doc/ForemanApi/Resources/LookupKey.html +111 -163
  21. data/doc/ForemanApi/Resources/Medium.html +113 -154
  22. data/doc/ForemanApi/Resources/Model.html +101 -148
  23. data/doc/ForemanApi/Resources/OperatingSystem.html +118 -173
  24. data/doc/ForemanApi/Resources/Organization.html +937 -0
  25. data/doc/ForemanApi/Resources/Parameter.html +158 -233
  26. data/doc/ForemanApi/Resources/Ptable.html +97 -142
  27. data/doc/ForemanApi/Resources/Puppetclass.html +95 -139
  28. data/doc/ForemanApi/Resources/Report.html +68 -98
  29. data/doc/ForemanApi/Resources/Role.html +85 -124
  30. data/doc/ForemanApi/Resources/Setting.html +58 -84
  31. data/doc/ForemanApi/Resources/SmartProxy.html +91 -133
  32. data/doc/ForemanApi/Resources/Subnet.html +141 -208
  33. data/doc/ForemanApi/Resources/TemplateCombination.html +65 -94
  34. data/doc/ForemanApi/Resources/TemplateKind.html +23 -32
  35. data/doc/ForemanApi/Resources/User.html +111 -163
  36. data/doc/ForemanApi/Resources/Usergroup.html +89 -130
  37. data/doc/ForemanApi/Resources.html +6 -6
  38. data/doc/ForemanApi.html +5 -5
  39. data/doc/_index.html +18 -4
  40. data/doc/class_list.html +1 -1
  41. data/doc/css/style.css +0 -10
  42. data/doc/file.MIT-LICENSE.html +24 -29
  43. data/doc/file.README.html +81 -60
  44. data/doc/frames.html +1 -1
  45. data/doc/index.html +81 -60
  46. data/doc/method_list.html +416 -312
  47. data/doc/top-level-namespace.html +3 -3
  48. data/lib/foreman_api/base.rb +16 -8
  49. data/lib/foreman_api/documentation.json +1 -1
  50. data/lib/foreman_api/resources/host.rb +9 -0
  51. data/lib/foreman_api/resources/location.rb +59 -0
  52. data/lib/foreman_api/resources/medium.rb +2 -2
  53. data/lib/foreman_api/resources/organization.rb +59 -0
  54. data/lib/foreman_api/version.rb +1 -1
  55. metadata +7 -3
data/doc/ForemanApi/Resources/HostClass.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: ForemanApi::Resources::HostClass
8
8
 
9
- &mdash; Documentation by YARD 0.8.5.2
9
+ &mdash; Documentation by YARD 0.8.3
10
10
 
11
11
  </title>
12
12
 
@@ -164,9 +164,8 @@
164
164
 
165
165
 
166
166
 
167
- <span class="summary_desc"><div class='inline'><p>
168
- First item: parsed data; second item: raw body.
169
- </p>
167
+ <span class="summary_desc"><div class='inline'>
168
+ <p>First item: parsed data; second item: raw body.</p>
170
169
  </div></span>
171
170
 
172
171
  </li>
@@ -189,9 +188,8 @@ First item: parsed data; second item: raw body.
189
188
 
190
189
 
191
190
 
192
- <span class="summary_desc"><div class='inline'><p>
193
- First item: parsed data; second item: raw body.
194
- </p>
191
+ <span class="summary_desc"><div class='inline'>
192
+ <p>First item: parsed data; second item: raw body.</p>
195
193
  </div></span>
196
194
 
197
195
  </li>
@@ -214,9 +212,8 @@ First item: parsed data; second item: raw body.
214
212
 
215
213
 
216
214
 
217
- <span class="summary_desc"><div class='inline'><p>
218
- First item: parsed data; second item: raw body.
219
- </p>
215
+ <span class="summary_desc"><div class='inline'>
216
+ <p>First item: parsed data; second item: raw body.</p>
220
217
  </div></span>
221
218
 
222
219
  </li>
@@ -254,10 +251,9 @@ First item: parsed data; second item: raw body.
254
251
  <td>
255
252
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host_class.rb', line 4</span>
256
253
 
257
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
258
- <span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>&quot;host_classes&quot;</span><span class='rbrack token'>]</span>
259
- <span class='rubyid_end end kw'>end</span>
260
- </pre>
254
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
255
+ <span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>host_classes</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
256
+ <span class='kw'>end</span></pre>
261
257
  </td>
262
258
  </tr>
263
259
  </table>
@@ -280,9 +276,8 @@ First item: parsed data; second item: raw body.
280
276
 
281
277
  </h3><div class="docstring">
282
278
  <div class="discussion">
283
- <p>
284
- First item: parsed data; second item: raw body
285
- </p>
279
+
280
+ <p>First item: parsed data; second item: raw body</p>
286
281
 
287
282
 
288
283
  </div>
@@ -303,9 +298,8 @@ First item: parsed data; second item: raw body
303
298
 
304
299
 
305
300
  &mdash;
306
- <div class='inline'><p>
307
- a hash of params to be passed to the service
308
- </p>
301
+ <div class='inline'>
302
+ <p>a hash of params to be passed to the service</p>
309
303
  </div>
310
304
 
311
305
  </li>
@@ -322,9 +316,8 @@ a hash of params to be passed to the service
322
316
 
323
317
 
324
318
  &mdash;
325
- <div class='inline'><p>
326
- additional http headers
327
- </p>
319
+ <div class='inline'>
320
+ <p>additional http headers</p>
328
321
  </div>
329
322
 
330
323
  </li>
@@ -344,9 +337,8 @@ additional http headers
344
337
 
345
338
  </span>
346
339
 
347
- &mdash; <div class='inline'><p>
348
- Id of host
349
- </p>
340
+ &mdash; <div class='inline'>
341
+ <p>Id of host</p>
350
342
  </div>
351
343
 
352
344
  </li>
@@ -358,9 +350,8 @@ Id of host
358
350
 
359
351
  </span>
360
352
 
361
- &mdash; <div class='inline'><p>
362
- Id of puppetclass
363
- </p>
353
+ &mdash; <div class='inline'>
354
+ <p>Id of puppetclass</p>
364
355
  </div>
365
356
 
366
357
  </li>
@@ -381,9 +372,8 @@ Id of puppetclass
381
372
 
382
373
 
383
374
  &mdash;
384
- <div class='inline'><p>
385
- First item: parsed data; second item: raw body
386
- </p>
375
+ <div class='inline'>
376
+ <p>First item: parsed data; second item: raw body</p>
387
377
  </div>
388
378
 
389
379
  </li>
@@ -403,10 +393,9 @@ First item: parsed data; second item: raw body
403
393
  <td>
404
394
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host_class.rb', line 23</span>
405
395
 
406
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
407
- <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
408
- <span class='rubyid_end end kw'>end</span>
409
- </pre>
396
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
397
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
398
+ <span class='kw'>end</span></pre>
410
399
  </td>
411
400
  </tr>
412
401
  </table>
@@ -423,9 +412,8 @@ First item: parsed data; second item: raw body
423
412
 
424
413
  </h3><div class="docstring">
425
414
  <div class="discussion">
426
- <p>
427
- First item: parsed data; second item: raw body
428
- </p>
415
+
416
+ <p>First item: parsed data; second item: raw body</p>
429
417
 
430
418
 
431
419
  </div>
@@ -446,9 +434,8 @@ First item: parsed data; second item: raw body
446
434
 
447
435
 
448
436
  &mdash;
449
- <div class='inline'><p>
450
- a hash of params to be passed to the service
451
- </p>
437
+ <div class='inline'>
438
+ <p>a hash of params to be passed to the service</p>
452
439
  </div>
453
440
 
454
441
  </li>
@@ -465,9 +452,8 @@ a hash of params to be passed to the service
465
452
 
466
453
 
467
454
  &mdash;
468
- <div class='inline'><p>
469
- additional http headers
470
- </p>
455
+ <div class='inline'>
456
+ <p>additional http headers</p>
471
457
  </div>
472
458
 
473
459
  </li>
@@ -487,9 +473,8 @@ additional http headers
487
473
 
488
474
  </span>
489
475
 
490
- &mdash; <div class='inline'><p>
491
- Id of puppetclass
492
- </p>
476
+ &mdash; <div class='inline'>
477
+ <p>Id of puppetclass</p>
493
478
  </div>
494
479
 
495
480
  </li>
@@ -501,9 +486,8 @@ Id of puppetclass
501
486
 
502
487
  </span>
503
488
 
504
- &mdash; <div class='inline'><p>
505
- Id of host
506
- </p>
489
+ &mdash; <div class='inline'>
490
+ <p>Id of host</p>
507
491
  </div>
508
492
 
509
493
  </li>
@@ -524,9 +508,8 @@ Id of host
524
508
 
525
509
 
526
510
  &mdash;
527
- <div class='inline'><p>
528
- First item: parsed data; second item: raw body
529
- </p>
511
+ <div class='inline'>
512
+ <p>First item: parsed data; second item: raw body</p>
530
513
  </div>
531
514
 
532
515
  </li>
@@ -546,10 +529,9 @@ First item: parsed data; second item: raw body
546
529
  <td>
547
530
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host_class.rb', line 33</span>
548
531
 
549
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
550
- <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
551
- <span class='rubyid_end end kw'>end</span>
552
- </pre>
532
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
533
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
534
+ <span class='kw'>end</span></pre>
553
535
  </td>
554
536
  </tr>
555
537
  </table>
@@ -566,9 +548,8 @@ First item: parsed data; second item: raw body
566
548
 
567
549
  </h3><div class="docstring">
568
550
  <div class="discussion">
569
- <p>
570
- First item: parsed data; second item: raw body
571
- </p>
551
+
552
+ <p>First item: parsed data; second item: raw body</p>
572
553
 
573
554
 
574
555
  </div>
@@ -589,9 +570,8 @@ First item: parsed data; second item: raw body
589
570
 
590
571
 
591
572
  &mdash;
592
- <div class='inline'><p>
593
- a hash of params to be passed to the service
594
- </p>
573
+ <div class='inline'>
574
+ <p>a hash of params to be passed to the service</p>
595
575
  </div>
596
576
 
597
577
  </li>
@@ -608,9 +588,8 @@ a hash of params to be passed to the service
608
588
 
609
589
 
610
590
  &mdash;
611
- <div class='inline'><p>
612
- additional http headers
613
- </p>
591
+ <div class='inline'>
592
+ <p>additional http headers</p>
614
593
  </div>
615
594
 
616
595
  </li>
@@ -630,9 +609,8 @@ additional http headers
630
609
 
631
610
  </span>
632
611
 
633
- &mdash; <div class='inline'><p>
634
- Part of <tt>/api/hosts/:host_id/puppetclass_ids</tt> path
635
- </p>
612
+ &mdash; <div class='inline'>
613
+ <p>Part of <tt>/api/hosts/:host_id/puppetclass_ids</tt> path</p>
636
614
  </div>
637
615
 
638
616
  </li>
@@ -653,9 +631,8 @@ Part of <tt>/api/hosts/:host_id/puppetclass_ids</tt> path
653
631
 
654
632
 
655
633
  &mdash;
656
- <div class='inline'><p>
657
- First item: parsed data; second item: raw body
658
- </p>
634
+ <div class='inline'>
635
+ <p>First item: parsed data; second item: raw body</p>
659
636
  </div>
660
637
 
661
638
  </li>
@@ -675,10 +652,9 @@ First item: parsed data; second item: raw body
675
652
  <td>
676
653
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host_class.rb', line 13</span>
677
654
 
678
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
679
- <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
680
- <span class='rubyid_end end kw'>end</span>
681
- </pre>
655
+ <span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
656
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
657
+ <span class='kw'>end</span></pre>
682
658
  </td>
683
659
  </tr>
684
660
  </table>
@@ -689,9 +665,9 @@ First item: parsed data; second item: raw body
689
665
  </div>
690
666
 
691
667
  <div id="footer">
692
- Generated on Tue Mar 19 09:50:26 2013 by
668
+ Generated on Thu Jun 20 12:05:22 2013 by
693
669
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
694
- 0.8.5.2 (ruby-1.8.7).
670
+ 0.8.3 (ruby-1.9.3).
695
671
  </div>
696
672
 
697
673
  </body>