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/HostgroupClass.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: ForemanApi::Resources::HostgroupClass
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/hostgroup_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;hostgroup_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'>hostgroup_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 hostgroup
349
- </p>
340
+ &mdash; <div class='inline'>
341
+ <p>Id of hostgroup</p>
350
342
  </div>
351
343
 
352
344
  </li>
@@ -358,9 +350,8 @@ Id of hostgroup
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/hostgroup_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
- Part of <tt>/api/hostgroups/:hostgroup_id/puppetclass_ids/:id</tt> path
492
- </p>
476
+ &mdash; <div class='inline'>
477
+ <p>Part of <tt>/api/hostgroups/:hostgroup_id/puppetclass_ids/:id</tt> path</p>
493
478
  </div>
494
479
 
495
480
  </li>
@@ -501,9 +486,8 @@ Part of <tt>/api/hostgroups/:hostgroup_id/puppetclass_ids/:id</tt> path
501
486
 
502
487
  </span>
503
488
 
504
- &mdash; <div class='inline'><p>
505
- Id of hostgroup
506
- </p>
489
+ &mdash; <div class='inline'>
490
+ <p>Id of hostgroup</p>
507
491
  </div>
508
492
 
509
493
  </li>
@@ -515,9 +499,8 @@ Id of hostgroup
515
499
 
516
500
  </span>
517
501
 
518
- &mdash; <div class='inline'><p>
519
- Id of puppetclass
520
- </p>
502
+ &mdash; <div class='inline'>
503
+ <p>Id of puppetclass</p>
521
504
  </div>
522
505
 
523
506
  </li>
@@ -538,9 +521,8 @@ Id of puppetclass
538
521
 
539
522
 
540
523
  &mdash;
541
- <div class='inline'><p>
542
- First item: parsed data; second item: raw body
543
- </p>
524
+ <div class='inline'>
525
+ <p>First item: parsed data; second item: raw body</p>
544
526
  </div>
545
527
 
546
528
  </li>
@@ -560,10 +542,9 @@ First item: parsed data; second item: raw body
560
542
  <td>
561
543
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup_class.rb', line 34</span>
562
544
 
563
- <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>
564
- <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>
565
- <span class='rubyid_end end kw'>end</span>
566
- </pre>
545
+ <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>
546
+ <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>
547
+ <span class='kw'>end</span></pre>
567
548
  </td>
568
549
  </tr>
569
550
  </table>
@@ -580,9 +561,8 @@ First item: parsed data; second item: raw body
580
561
 
581
562
  </h3><div class="docstring">
582
563
  <div class="discussion">
583
- <p>
584
- First item: parsed data; second item: raw body
585
- </p>
564
+
565
+ <p>First item: parsed data; second item: raw body</p>
586
566
 
587
567
 
588
568
  </div>
@@ -603,9 +583,8 @@ First item: parsed data; second item: raw body
603
583
 
604
584
 
605
585
  &mdash;
606
- <div class='inline'><p>
607
- a hash of params to be passed to the service
608
- </p>
586
+ <div class='inline'>
587
+ <p>a hash of params to be passed to the service</p>
609
588
  </div>
610
589
 
611
590
  </li>
@@ -622,9 +601,8 @@ a hash of params to be passed to the service
622
601
 
623
602
 
624
603
  &mdash;
625
- <div class='inline'><p>
626
- additional http headers
627
- </p>
604
+ <div class='inline'>
605
+ <p>additional http headers</p>
628
606
  </div>
629
607
 
630
608
  </li>
@@ -644,9 +622,8 @@ additional http headers
644
622
 
645
623
  </span>
646
624
 
647
- &mdash; <div class='inline'><p>
648
- Part of <tt>/api/hostgroups/:hostgroup_id/puppetclass_ids</tt> path
649
- </p>
625
+ &mdash; <div class='inline'>
626
+ <p>Part of <tt>/api/hostgroups/:hostgroup_id/puppetclass_ids</tt> path</p>
650
627
  </div>
651
628
 
652
629
  </li>
@@ -667,9 +644,8 @@ Part of <tt>/api/hostgroups/:hostgroup_id/puppetclass_ids</tt> path
667
644
 
668
645
 
669
646
  &mdash;
670
- <div class='inline'><p>
671
- First item: parsed data; second item: raw body
672
- </p>
647
+ <div class='inline'>
648
+ <p>First item: parsed data; second item: raw body</p>
673
649
  </div>
674
650
 
675
651
  </li>
@@ -689,10 +665,9 @@ First item: parsed data; second item: raw body
689
665
  <td>
690
666
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup_class.rb', line 13</span>
691
667
 
692
- <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>
693
- <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>
694
- <span class='rubyid_end end kw'>end</span>
695
- </pre>
668
+ <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>
669
+ <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>
670
+ <span class='kw'>end</span></pre>
696
671
  </td>
697
672
  </tr>
698
673
  </table>
@@ -703,9 +678,9 @@ First item: parsed data; second item: raw body
703
678
  </div>
704
679
 
705
680
  <div id="footer">
706
- Generated on Tue Mar 19 09:50:27 2013 by
681
+ Generated on Thu Jun 20 12:05:23 2013 by
707
682
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
708
- 0.8.5.2 (ruby-1.8.7).
683
+ 0.8.3 (ruby-1.9.3).
709
684
  </div>
710
685
 
711
686
  </body>