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.
- data/README.rdoc +35 -18
- data/doc/ForemanApi/Resources/Architecture.html +93 -136
- data/doc/ForemanApi/Resources/Audit.html +42 -60
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +129 -190
- data/doc/ForemanApi/Resources/Bookmark.html +97 -142
- data/doc/ForemanApi/Resources/CommonParameter.html +93 -136
- data/doc/ForemanApi/Resources/ComputeResource.html +131 -190
- data/doc/ForemanApi/Resources/ConfigTemplate.html +145 -211
- data/doc/ForemanApi/Resources/Dashboard.html +21 -29
- data/doc/ForemanApi/Resources/Domain.html +103 -151
- data/doc/ForemanApi/Resources/Environment.html +89 -130
- data/doc/ForemanApi/Resources/FactValue.html +29 -41
- data/doc/ForemanApi/Resources/Home.html +32 -45
- data/doc/ForemanApi/Resources/Host.html +317 -251
- data/doc/ForemanApi/Resources/HostClass.html +55 -79
- data/doc/ForemanApi/Resources/Hostgroup.html +125 -184
- data/doc/ForemanApi/Resources/HostgroupClass.html +57 -82
- data/doc/ForemanApi/Resources/Image.html +109 -160
- data/doc/ForemanApi/Resources/Location.html +937 -0
- data/doc/ForemanApi/Resources/LookupKey.html +111 -163
- data/doc/ForemanApi/Resources/Medium.html +113 -154
- data/doc/ForemanApi/Resources/Model.html +101 -148
- data/doc/ForemanApi/Resources/OperatingSystem.html +118 -173
- data/doc/ForemanApi/Resources/Organization.html +937 -0
- data/doc/ForemanApi/Resources/Parameter.html +158 -233
- data/doc/ForemanApi/Resources/Ptable.html +97 -142
- data/doc/ForemanApi/Resources/Puppetclass.html +95 -139
- data/doc/ForemanApi/Resources/Report.html +68 -98
- data/doc/ForemanApi/Resources/Role.html +85 -124
- data/doc/ForemanApi/Resources/Setting.html +58 -84
- data/doc/ForemanApi/Resources/SmartProxy.html +91 -133
- data/doc/ForemanApi/Resources/Subnet.html +141 -208
- data/doc/ForemanApi/Resources/TemplateCombination.html +65 -94
- data/doc/ForemanApi/Resources/TemplateKind.html +23 -32
- data/doc/ForemanApi/Resources/User.html +111 -163
- data/doc/ForemanApi/Resources/Usergroup.html +89 -130
- data/doc/ForemanApi/Resources.html +6 -6
- data/doc/ForemanApi.html +5 -5
- data/doc/_index.html +18 -4
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +0 -10
- data/doc/file.MIT-LICENSE.html +24 -29
- data/doc/file.README.html +81 -60
- data/doc/frames.html +1 -1
- data/doc/index.html +81 -60
- data/doc/method_list.html +416 -312
- data/doc/top-level-namespace.html +3 -3
- data/lib/foreman_api/base.rb +16 -8
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/host.rb +9 -0
- data/lib/foreman_api/resources/location.rb +59 -0
- data/lib/foreman_api/resources/medium.rb +2 -2
- data/lib/foreman_api/resources/organization.rb +59 -0
- data/lib/foreman_api/version.rb +1 -1
- metadata +7 -3
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: ForemanApi::Resources::Setting
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— 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'
|
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'
|
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'
|
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/setting.rb', line 4</span>
|
256
253
|
|
257
|
-
<span class='
|
258
|
-
<span class='
|
259
|
-
<span class='
|
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'>"</span><span class='tstring_content'>settings</span><span class='tstring_end'>"</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
|
-
|
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
|
—
|
306
|
-
<div class='inline'
|
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
|
—
|
325
|
-
<div class='inline'
|
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
|
-
— <div class='inline'
|
348
|
-
Sort results
|
349
|
-
</p>
|
340
|
+
— <div class='inline'>
|
341
|
+
<p>Sort results</p>
|
350
342
|
</div>
|
351
343
|
|
352
344
|
</li>
|
@@ -358,9 +350,8 @@ Sort results
|
|
358
350
|
|
359
351
|
</span>
|
360
352
|
|
361
|
-
— <div class='inline'
|
362
|
-
Paginate results
|
363
|
-
</p>
|
353
|
+
— <div class='inline'>
|
354
|
+
<p>Paginate results</p>
|
364
355
|
</div>
|
365
356
|
|
366
357
|
</li>
|
@@ -372,9 +363,8 @@ Paginate results
|
|
372
363
|
|
373
364
|
</span>
|
374
365
|
|
375
|
-
— <div class='inline'
|
376
|
-
Number of entries per request
|
377
|
-
</p>
|
366
|
+
— <div class='inline'>
|
367
|
+
<p>Number of entries per request</p>
|
378
368
|
</div>
|
379
369
|
|
380
370
|
</li>
|
@@ -386,9 +376,8 @@ Number of entries per request
|
|
386
376
|
|
387
377
|
</span>
|
388
378
|
|
389
|
-
— <div class='inline'
|
390
|
-
Filter results
|
391
|
-
</p>
|
379
|
+
— <div class='inline'>
|
380
|
+
<p>Filter results</p>
|
392
381
|
</div>
|
393
382
|
|
394
383
|
</li>
|
@@ -409,9 +398,8 @@ Filter results
|
|
409
398
|
|
410
399
|
|
411
400
|
—
|
412
|
-
<div class='inline'
|
413
|
-
First item: parsed data; second item: raw body
|
414
|
-
</p>
|
401
|
+
<div class='inline'>
|
402
|
+
<p>First item: parsed data; second item: raw body</p>
|
415
403
|
</div>
|
416
404
|
|
417
405
|
</li>
|
@@ -431,10 +419,9 @@ First item: parsed data; second item: raw body
|
|
431
419
|
<td>
|
432
420
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/setting.rb', line 16</span>
|
433
421
|
|
434
|
-
<span class='
|
435
|
-
<span class='
|
436
|
-
<span class='
|
437
|
-
</pre>
|
422
|
+
<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>
|
423
|
+
<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>
|
424
|
+
<span class='kw'>end</span></pre>
|
438
425
|
</td>
|
439
426
|
</tr>
|
440
427
|
</table>
|
@@ -451,9 +438,8 @@ First item: parsed data; second item: raw body
|
|
451
438
|
|
452
439
|
</h3><div class="docstring">
|
453
440
|
<div class="discussion">
|
454
|
-
|
455
|
-
First item: parsed data; second item: raw body
|
456
|
-
</p>
|
441
|
+
|
442
|
+
<p>First item: parsed data; second item: raw body</p>
|
457
443
|
|
458
444
|
|
459
445
|
</div>
|
@@ -474,9 +460,8 @@ First item: parsed data; second item: raw body
|
|
474
460
|
|
475
461
|
|
476
462
|
—
|
477
|
-
<div class='inline'
|
478
|
-
a hash of params to be passed to the service
|
479
|
-
</p>
|
463
|
+
<div class='inline'>
|
464
|
+
<p>a hash of params to be passed to the service</p>
|
480
465
|
</div>
|
481
466
|
|
482
467
|
</li>
|
@@ -493,9 +478,8 @@ a hash of params to be passed to the service
|
|
493
478
|
|
494
479
|
|
495
480
|
—
|
496
|
-
<div class='inline'
|
497
|
-
additional http headers
|
498
|
-
</p>
|
481
|
+
<div class='inline'>
|
482
|
+
<p>additional http headers</p>
|
499
483
|
</div>
|
500
484
|
|
501
485
|
</li>
|
@@ -533,9 +517,8 @@ additional http headers
|
|
533
517
|
|
534
518
|
|
535
519
|
—
|
536
|
-
<div class='inline'
|
537
|
-
First item: parsed data; second item: raw body
|
538
|
-
</p>
|
520
|
+
<div class='inline'>
|
521
|
+
<p>First item: parsed data; second item: raw body</p>
|
539
522
|
</div>
|
540
523
|
|
541
524
|
</li>
|
@@ -555,10 +538,9 @@ First item: parsed data; second item: raw body
|
|
555
538
|
<td>
|
556
539
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/setting.rb', line 25</span>
|
557
540
|
|
558
|
-
<span class='
|
559
|
-
<span class='
|
560
|
-
<span class='
|
561
|
-
</pre>
|
541
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</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>
|
542
|
+
<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>
|
543
|
+
<span class='kw'>end</span></pre>
|
562
544
|
</td>
|
563
545
|
</tr>
|
564
546
|
</table>
|
@@ -575,9 +557,8 @@ First item: parsed data; second item: raw body
|
|
575
557
|
|
576
558
|
</h3><div class="docstring">
|
577
559
|
<div class="discussion">
|
578
|
-
|
579
|
-
First item: parsed data; second item: raw body
|
580
|
-
</p>
|
560
|
+
|
561
|
+
<p>First item: parsed data; second item: raw body</p>
|
581
562
|
|
582
563
|
|
583
564
|
</div>
|
@@ -598,9 +579,8 @@ First item: parsed data; second item: raw body
|
|
598
579
|
|
599
580
|
|
600
581
|
—
|
601
|
-
<div class='inline'
|
602
|
-
a hash of params to be passed to the service
|
603
|
-
</p>
|
582
|
+
<div class='inline'>
|
583
|
+
<p>a hash of params to be passed to the service</p>
|
604
584
|
</div>
|
605
585
|
|
606
586
|
</li>
|
@@ -617,9 +597,8 @@ a hash of params to be passed to the service
|
|
617
597
|
|
618
598
|
|
619
599
|
—
|
620
|
-
<div class='inline'
|
621
|
-
additional http headers
|
622
|
-
</p>
|
600
|
+
<div class='inline'>
|
601
|
+
<p>additional http headers</p>
|
623
602
|
</div>
|
624
603
|
|
625
604
|
</li>
|
@@ -648,14 +627,11 @@ additional http headers
|
|
648
627
|
|
649
628
|
</span>
|
650
629
|
|
651
|
-
— <div class='inline'
|
652
|
-
allowed keys are
|
653
|
-
|
654
|
-
<
|
655
|
-
|
656
|
-
|
657
|
-
</li>
|
658
|
-
</ul>
|
630
|
+
— <div class='inline'>
|
631
|
+
<p>allowed keys are:</p>
|
632
|
+
<ul><li>
|
633
|
+
<p>value [String]</p>
|
634
|
+
</li></ul>
|
659
635
|
</div>
|
660
636
|
|
661
637
|
</li>
|
@@ -676,9 +652,8 @@ allowed keys are:
|
|
676
652
|
|
677
653
|
|
678
654
|
—
|
679
|
-
<div class='inline'
|
680
|
-
First item: parsed data; second item: raw body
|
681
|
-
</p>
|
655
|
+
<div class='inline'>
|
656
|
+
<p>First item: parsed data; second item: raw body</p>
|
682
657
|
</div>
|
683
658
|
|
684
659
|
</li>
|
@@ -698,10 +673,9 @@ First item: parsed data; second item: raw body
|
|
698
673
|
<td>
|
699
674
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/setting.rb', line 37</span>
|
700
675
|
|
701
|
-
<span class='
|
702
|
-
<span class='
|
703
|
-
<span class='
|
704
|
-
</pre>
|
676
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</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>
|
677
|
+
<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>
|
678
|
+
<span class='kw'>end</span></pre>
|
705
679
|
</td>
|
706
680
|
</tr>
|
707
681
|
</table>
|
@@ -712,9 +686,9 @@ First item: parsed data; second item: raw body
|
|
712
686
|
</div>
|
713
687
|
|
714
688
|
<div id="footer">
|
715
|
-
Generated on
|
689
|
+
Generated on Thu Jun 20 12:05:21 2013 by
|
716
690
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
717
|
-
0.8.
|
691
|
+
0.8.3 (ruby-1.9.3).
|
718
692
|
</div>
|
719
693
|
|
720
694
|
</body>
|