foreman_api 0.1.1 → 0.1.2
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/.gitignore +3 -0
- data/Gemfile +2 -0
- data/Rakefile +0 -1
- data/doc/ForemanApi.html +5 -5
- data/doc/ForemanApi/Resources.html +6 -6
- data/doc/ForemanApi/Resources/Architecture.html +260 -127
- data/doc/ForemanApi/Resources/Audit.html +118 -51
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +314 -163
- data/doc/ForemanApi/Resources/Bookmark.html +266 -131
- data/doc/ForemanApi/Resources/CommonParameter.html +260 -127
- data/doc/ForemanApi/Resources/ComputeResource.html +314 -165
- data/doc/ForemanApi/Resources/ConfigTemplate.html +387 -195
- data/doc/ForemanApi/Resources/Dashboard.html +53 -27
- data/doc/ForemanApi/Resources/Domain.html +275 -137
- data/doc/ForemanApi/Resources/Environment.html +254 -123
- data/doc/ForemanApi/Resources/FactValue.html +75 -32
- data/doc/ForemanApi/Resources/Home.html +92 -43
- data/doc/ForemanApi/Resources/Host.html +401 -212
- data/doc/ForemanApi/Resources/HostClass.html +698 -0
- data/doc/ForemanApi/Resources/Hostgroup.html +308 -159
- data/doc/ForemanApi/Resources/HostgroupClass.html +712 -0
- data/doc/ForemanApi/Resources/Image.html +284 -143
- data/doc/ForemanApi/Resources/LookupKey.html +295 -140
- data/doc/ForemanApi/Resources/Medium.html +278 -145
- data/doc/ForemanApi/Resources/Model.html +272 -135
- data/doc/ForemanApi/Resources/OperatingSystem.html +323 -160
- data/doc/ForemanApi/Resources/Parameter.html +1512 -0
- data/doc/ForemanApi/Resources/Ptable.html +266 -131
- data/doc/ForemanApi/Resources/Puppetclass.html +295 -131
- data/doc/ForemanApi/Resources/Report.html +311 -71
- data/doc/ForemanApi/Resources/Role.html +248 -119
- data/doc/ForemanApi/Resources/Setting.html +156 -76
- data/doc/ForemanApi/Resources/SmartProxy.html +257 -125
- data/doc/ForemanApi/Resources/Subnet.html +332 -175
- data/doc/ForemanApi/Resources/TemplateCombination.html +826 -0
- data/doc/ForemanApi/Resources/TemplateKind.html +56 -29
- data/doc/ForemanApi/Resources/User.html +287 -145
- data/doc/ForemanApi/Resources/Usergroup.html +272 -115
- data/doc/_index.html +32 -4
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +10 -0
- data/doc/file.MIT-LICENSE.html +29 -24
- data/doc/file.README.html +60 -59
- data/doc/frames.html +1 -1
- data/doc/index.html +60 -59
- data/doc/method_list.html +434 -266
- data/doc/top-level-namespace.html +3 -3
- data/lib/foreman_api.rb +0 -13
- data/lib/foreman_api/base.rb +77 -7
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/architecture.rb +27 -32
- data/lib/foreman_api/resources/audit.rb +9 -10
- data/lib/foreman_api/resources/auth_source_ldap.rb +47 -52
- data/lib/foreman_api/resources/bookmark.rb +31 -36
- data/lib/foreman_api/resources/common_parameter.rb +27 -32
- data/lib/foreman_api/resources/compute_resource.rb +43 -48
- data/lib/foreman_api/resources/config_template.rb +43 -50
- data/lib/foreman_api/resources/dashboard.rb +4 -5
- data/lib/foreman_api/resources/domain.rb +30 -35
- data/lib/foreman_api/resources/environment.rb +25 -30
- data/lib/foreman_api/resources/fact_value.rb +5 -5
- data/lib/foreman_api/resources/home.rb +7 -9
- data/lib/foreman_api/resources/host.rb +63 -69
- data/lib/foreman_api/resources/host_class.rb +39 -0
- data/lib/foreman_api/resources/hostgroup.rb +43 -48
- data/lib/foreman_api/resources/hostgroup_class.rb +40 -0
- data/lib/foreman_api/resources/image.rb +40 -45
- data/lib/foreman_api/resources/lookup_key.rb +36 -40
- data/lib/foreman_api/resources/medium.rb +29 -34
- data/lib/foreman_api/resources/model.rb +31 -36
- data/lib/foreman_api/resources/operating_system.rb +39 -45
- data/lib/foreman_api/resources/parameter.rb +96 -0
- data/lib/foreman_api/resources/ptable.rb +29 -34
- data/lib/foreman_api/resources/puppetclass.rb +31 -34
- data/lib/foreman_api/resources/report.rb +17 -20
- data/lib/foreman_api/resources/role.rb +25 -30
- data/lib/foreman_api/resources/setting.rb +15 -18
- data/lib/foreman_api/resources/smart_proxy.rb +27 -32
- data/lib/foreman_api/resources/subnet.rb +47 -52
- data/lib/foreman_api/resources/template_combination.rb +21 -25
- data/lib/foreman_api/resources/template_kind.rb +4 -5
- data/lib/foreman_api/resources/user.rb +36 -41
- data/lib/foreman_api/resources/usergroup.rb +25 -30
- data/lib/foreman_api/version.rb +1 -1
- metadata +10 -2
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: ForemanApi::Resources::OperatingSystem
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -150,7 +150,7 @@
|
|
150
150
|
<li class="public ">
|
151
151
|
<span class="summary_signature">
|
152
152
|
|
153
|
-
<a href="#bootfiles-instance_method" title="#bootfiles (instance method)">- (
|
153
|
+
<a href="#bootfiles-instance_method" title="#bootfiles (instance method)">- (Array) <strong>bootfiles</strong>(params = {}, headers = {}) </a>
|
154
154
|
|
155
155
|
|
156
156
|
|
@@ -164,7 +164,10 @@
|
|
164
164
|
|
165
165
|
|
166
166
|
|
167
|
-
<span class="summary_desc"><div class='inline'
|
167
|
+
<span class="summary_desc"><div class='inline'><p>
|
168
|
+
First item: parsed data; second item: raw body.
|
169
|
+
</p>
|
170
|
+
</div></span>
|
168
171
|
|
169
172
|
</li>
|
170
173
|
|
@@ -172,7 +175,7 @@
|
|
172
175
|
<li class="public ">
|
173
176
|
<span class="summary_signature">
|
174
177
|
|
175
|
-
<a href="#create-instance_method" title="#create (instance method)">- (
|
178
|
+
<a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
|
176
179
|
|
177
180
|
|
178
181
|
|
@@ -186,7 +189,10 @@
|
|
186
189
|
|
187
190
|
|
188
191
|
|
189
|
-
<span class="summary_desc"><div class='inline'
|
192
|
+
<span class="summary_desc"><div class='inline'><p>
|
193
|
+
First item: parsed data; second item: raw body.
|
194
|
+
</p>
|
195
|
+
</div></span>
|
190
196
|
|
191
197
|
</li>
|
192
198
|
|
@@ -194,7 +200,7 @@
|
|
194
200
|
<li class="public ">
|
195
201
|
<span class="summary_signature">
|
196
202
|
|
197
|
-
<a href="#destroy-instance_method" title="#destroy (instance method)">- (
|
203
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
|
198
204
|
|
199
205
|
|
200
206
|
|
@@ -208,7 +214,10 @@
|
|
208
214
|
|
209
215
|
|
210
216
|
|
211
|
-
<span class="summary_desc"><div class='inline'
|
217
|
+
<span class="summary_desc"><div class='inline'><p>
|
218
|
+
First item: parsed data; second item: raw body.
|
219
|
+
</p>
|
220
|
+
</div></span>
|
212
221
|
|
213
222
|
</li>
|
214
223
|
|
@@ -216,7 +225,7 @@
|
|
216
225
|
<li class="public ">
|
217
226
|
<span class="summary_signature">
|
218
227
|
|
219
|
-
<a href="#index-instance_method" title="#index (instance method)">- (
|
228
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
220
229
|
|
221
230
|
|
222
231
|
|
@@ -230,7 +239,10 @@
|
|
230
239
|
|
231
240
|
|
232
241
|
|
233
|
-
<span class="summary_desc"><div class='inline'
|
242
|
+
<span class="summary_desc"><div class='inline'><p>
|
243
|
+
First item: parsed data; second item: raw body.
|
244
|
+
</p>
|
245
|
+
</div></span>
|
234
246
|
|
235
247
|
</li>
|
236
248
|
|
@@ -238,7 +250,7 @@
|
|
238
250
|
<li class="public ">
|
239
251
|
<span class="summary_signature">
|
240
252
|
|
241
|
-
<a href="#show-instance_method" title="#show (instance method)">- (
|
253
|
+
<a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
|
242
254
|
|
243
255
|
|
244
256
|
|
@@ -252,7 +264,10 @@
|
|
252
264
|
|
253
265
|
|
254
266
|
|
255
|
-
<span class="summary_desc"><div class='inline'
|
267
|
+
<span class="summary_desc"><div class='inline'><p>
|
268
|
+
First item: parsed data; second item: raw body.
|
269
|
+
</p>
|
270
|
+
</div></span>
|
256
271
|
|
257
272
|
</li>
|
258
273
|
|
@@ -260,7 +275,7 @@
|
|
260
275
|
<li class="public ">
|
261
276
|
<span class="summary_signature">
|
262
277
|
|
263
|
-
<a href="#update-instance_method" title="#update (instance method)">- (
|
278
|
+
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
|
264
279
|
|
265
280
|
|
266
281
|
|
@@ -274,7 +289,10 @@
|
|
274
289
|
|
275
290
|
|
276
291
|
|
277
|
-
<span class="summary_desc"><div class='inline'
|
292
|
+
<span class="summary_desc"><div class='inline'><p>
|
293
|
+
First item: parsed data; second item: raw body.
|
294
|
+
</p>
|
295
|
+
</div></span>
|
278
296
|
|
279
297
|
</li>
|
280
298
|
|
@@ -311,9 +329,10 @@
|
|
311
329
|
<td>
|
312
330
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 4</span>
|
313
331
|
|
314
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='
|
315
|
-
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='
|
316
|
-
<span class='kw'>end</span
|
332
|
+
<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>
|
333
|
+
<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'>"operatingsystems"</span><span class='rbrack token'>]</span>
|
334
|
+
<span class='rubyid_end end kw'>end</span>
|
335
|
+
</pre>
|
317
336
|
</td>
|
318
337
|
</tr>
|
319
338
|
</table>
|
@@ -328,7 +347,7 @@
|
|
328
347
|
<div class="method_details first">
|
329
348
|
<h3 class="signature first" id="bootfiles-instance_method">
|
330
349
|
|
331
|
-
- (<tt>
|
350
|
+
- (<tt>Array</tt>) <strong>bootfiles</strong>(params = {}, headers = {})
|
332
351
|
|
333
352
|
|
334
353
|
|
@@ -336,7 +355,10 @@
|
|
336
355
|
|
337
356
|
</h3><div class="docstring">
|
338
357
|
<div class="discussion">
|
339
|
-
|
358
|
+
<p>
|
359
|
+
First item: parsed data; second item: raw body
|
360
|
+
</p>
|
361
|
+
|
340
362
|
|
341
363
|
</div>
|
342
364
|
</div>
|
@@ -352,12 +374,13 @@
|
|
352
374
|
<span class='type'>(<tt>Hash</tt>)</span>
|
353
375
|
|
354
376
|
|
355
|
-
<em class="default">(defaults to: <tt>{
|
377
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
356
378
|
|
357
379
|
|
358
380
|
—
|
359
|
-
<div class='inline'>
|
360
|
-
|
381
|
+
<div class='inline'><p>
|
382
|
+
a hash of params to be passed to the service
|
383
|
+
</p>
|
361
384
|
</div>
|
362
385
|
|
363
386
|
</li>
|
@@ -370,12 +393,13 @@
|
|
370
393
|
<span class='type'>(<tt>Hash</tt>)</span>
|
371
394
|
|
372
395
|
|
373
|
-
<em class="default">(defaults to: <tt>{
|
396
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
374
397
|
|
375
398
|
|
376
399
|
—
|
377
|
-
<div class='inline'>
|
378
|
-
|
400
|
+
<div class='inline'><p>
|
401
|
+
additional http headers
|
402
|
+
</p>
|
379
403
|
</div>
|
380
404
|
|
381
405
|
</li>
|
@@ -420,6 +444,25 @@
|
|
420
444
|
|
421
445
|
|
422
446
|
|
447
|
+
<p class="tag_title">Returns:</p>
|
448
|
+
<ul class="return">
|
449
|
+
|
450
|
+
<li>
|
451
|
+
|
452
|
+
|
453
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
—
|
458
|
+
<div class='inline'><p>
|
459
|
+
First item: parsed data; second item: raw body
|
460
|
+
</p>
|
461
|
+
</div>
|
462
|
+
|
463
|
+
</li>
|
464
|
+
|
465
|
+
</ul>
|
423
466
|
|
424
467
|
</div><table class="source_code">
|
425
468
|
<tr>
|
@@ -427,20 +470,17 @@
|
|
427
470
|
<pre class="lines">
|
428
471
|
|
429
472
|
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
83
|
434
|
-
84</pre>
|
473
|
+
76
|
474
|
+
77
|
475
|
+
78</pre>
|
435
476
|
</td>
|
436
477
|
<td>
|
437
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line
|
478
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 76</span>
|
438
479
|
|
439
|
-
<span class='kw'>def</span> <span class='
|
440
|
-
<span class='
|
441
|
-
|
442
|
-
|
443
|
-
<span class='kw'>end</span></pre>
|
480
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_bootfiles identifier id'>bootfiles</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>
|
481
|
+
<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>
|
482
|
+
<span class='rubyid_end end kw'>end</span>
|
483
|
+
</pre>
|
444
484
|
</td>
|
445
485
|
</tr>
|
446
486
|
</table>
|
@@ -449,7 +489,7 @@
|
|
449
489
|
<div class="method_details ">
|
450
490
|
<h3 class="signature " id="create-instance_method">
|
451
491
|
|
452
|
-
- (<tt>
|
492
|
+
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
|
453
493
|
|
454
494
|
|
455
495
|
|
@@ -457,7 +497,10 @@
|
|
457
497
|
|
458
498
|
</h3><div class="docstring">
|
459
499
|
<div class="discussion">
|
460
|
-
|
500
|
+
<p>
|
501
|
+
First item: parsed data; second item: raw body
|
502
|
+
</p>
|
503
|
+
|
461
504
|
|
462
505
|
</div>
|
463
506
|
</div>
|
@@ -473,12 +516,13 @@
|
|
473
516
|
<span class='type'>(<tt>Hash</tt>)</span>
|
474
517
|
|
475
518
|
|
476
|
-
<em class="default">(defaults to: <tt>{
|
519
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
477
520
|
|
478
521
|
|
479
522
|
—
|
480
|
-
<div class='inline'>
|
481
|
-
|
523
|
+
<div class='inline'><p>
|
524
|
+
a hash of params to be passed to the service
|
525
|
+
</p>
|
482
526
|
</div>
|
483
527
|
|
484
528
|
</li>
|
@@ -491,12 +535,13 @@
|
|
491
535
|
<span class='type'>(<tt>Hash</tt>)</span>
|
492
536
|
|
493
537
|
|
494
|
-
<em class="default">(defaults to: <tt>{
|
538
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
495
539
|
|
496
540
|
|
497
541
|
—
|
498
|
-
<div class='inline'>
|
499
|
-
|
542
|
+
<div class='inline'><p>
|
543
|
+
additional http headers
|
544
|
+
</p>
|
500
545
|
</div>
|
501
546
|
|
502
547
|
</li>
|
@@ -516,19 +561,26 @@
|
|
516
561
|
|
517
562
|
</span>
|
518
563
|
|
519
|
-
— <div class='inline'>
|
520
|
-
|
521
|
-
|
522
|
-
<
|
523
|
-
|
524
|
-
|
525
|
-
</li
|
526
|
-
<
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
</li
|
564
|
+
— <div class='inline'><p>
|
565
|
+
allowed keys are:
|
566
|
+
</p>
|
567
|
+
<ul>
|
568
|
+
<li>family [String]
|
569
|
+
|
570
|
+
</li>
|
571
|
+
<li>major [String]
|
572
|
+
|
573
|
+
</li>
|
574
|
+
<li>minor [String]
|
575
|
+
|
576
|
+
</li>
|
577
|
+
<li>name [String]
|
578
|
+
|
579
|
+
</li>
|
580
|
+
<li>release_name [String]
|
581
|
+
|
582
|
+
</li>
|
583
|
+
</ul>
|
532
584
|
</div>
|
533
585
|
|
534
586
|
</li>
|
@@ -538,6 +590,25 @@
|
|
538
590
|
|
539
591
|
|
540
592
|
|
593
|
+
<p class="tag_title">Returns:</p>
|
594
|
+
<ul class="return">
|
595
|
+
|
596
|
+
<li>
|
597
|
+
|
598
|
+
|
599
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
600
|
+
|
601
|
+
|
602
|
+
|
603
|
+
—
|
604
|
+
<div class='inline'><p>
|
605
|
+
First item: parsed data; second item: raw body
|
606
|
+
</p>
|
607
|
+
</div>
|
608
|
+
|
609
|
+
</li>
|
610
|
+
|
611
|
+
</ul>
|
541
612
|
|
542
613
|
</div><table class="source_code">
|
543
614
|
<tr>
|
@@ -545,20 +616,17 @@
|
|
545
616
|
<pre class="lines">
|
546
617
|
|
547
618
|
|
619
|
+
40
|
548
620
|
41
|
549
|
-
42
|
550
|
-
43
|
551
|
-
44
|
552
|
-
45</pre>
|
621
|
+
42</pre>
|
553
622
|
</td>
|
554
623
|
<td>
|
555
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line
|
624
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 40</span>
|
556
625
|
|
557
|
-
<span class='kw'>def</span> <span class='
|
558
|
-
<span class='
|
559
|
-
|
560
|
-
|
561
|
-
<span class='kw'>end</span></pre>
|
626
|
+
<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>
|
627
|
+
<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>
|
628
|
+
<span class='rubyid_end end kw'>end</span>
|
629
|
+
</pre>
|
562
630
|
</td>
|
563
631
|
</tr>
|
564
632
|
</table>
|
@@ -567,7 +635,7 @@
|
|
567
635
|
<div class="method_details ">
|
568
636
|
<h3 class="signature " id="destroy-instance_method">
|
569
637
|
|
570
|
-
- (<tt>
|
638
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
571
639
|
|
572
640
|
|
573
641
|
|
@@ -575,7 +643,10 @@
|
|
575
643
|
|
576
644
|
</h3><div class="docstring">
|
577
645
|
<div class="discussion">
|
578
|
-
|
646
|
+
<p>
|
647
|
+
First item: parsed data; second item: raw body
|
648
|
+
</p>
|
649
|
+
|
579
650
|
|
580
651
|
</div>
|
581
652
|
</div>
|
@@ -591,12 +662,13 @@
|
|
591
662
|
<span class='type'>(<tt>Hash</tt>)</span>
|
592
663
|
|
593
664
|
|
594
|
-
<em class="default">(defaults to: <tt>{
|
665
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
595
666
|
|
596
667
|
|
597
668
|
—
|
598
|
-
<div class='inline'>
|
599
|
-
|
669
|
+
<div class='inline'><p>
|
670
|
+
a hash of params to be passed to the service
|
671
|
+
</p>
|
600
672
|
</div>
|
601
673
|
|
602
674
|
</li>
|
@@ -609,12 +681,13 @@
|
|
609
681
|
<span class='type'>(<tt>Hash</tt>)</span>
|
610
682
|
|
611
683
|
|
612
|
-
<em class="default">(defaults to: <tt>{
|
684
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
613
685
|
|
614
686
|
|
615
687
|
—
|
616
|
-
<div class='inline'>
|
617
|
-
|
688
|
+
<div class='inline'><p>
|
689
|
+
additional http headers
|
690
|
+
</p>
|
618
691
|
</div>
|
619
692
|
|
620
693
|
</li>
|
@@ -641,6 +714,25 @@
|
|
641
714
|
|
642
715
|
|
643
716
|
|
717
|
+
<p class="tag_title">Returns:</p>
|
718
|
+
<ul class="return">
|
719
|
+
|
720
|
+
<li>
|
721
|
+
|
722
|
+
|
723
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
724
|
+
|
725
|
+
|
726
|
+
|
727
|
+
—
|
728
|
+
<div class='inline'><p>
|
729
|
+
First item: parsed data; second item: raw body
|
730
|
+
</p>
|
731
|
+
</div>
|
732
|
+
|
733
|
+
</li>
|
734
|
+
|
735
|
+
</ul>
|
644
736
|
|
645
737
|
</div><table class="source_code">
|
646
738
|
<tr>
|
@@ -648,20 +740,17 @@
|
|
648
740
|
<pre class="lines">
|
649
741
|
|
650
742
|
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
71
|
655
|
-
72</pre>
|
743
|
+
65
|
744
|
+
66
|
745
|
+
67</pre>
|
656
746
|
</td>
|
657
747
|
<td>
|
658
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line
|
748
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 65</span>
|
659
749
|
|
660
|
-
<span class='kw'>def</span> <span class='
|
661
|
-
<span class='
|
662
|
-
|
663
|
-
|
664
|
-
<span class='kw'>end</span></pre>
|
750
|
+
<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>
|
751
|
+
<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>
|
752
|
+
<span class='rubyid_end end kw'>end</span>
|
753
|
+
</pre>
|
665
754
|
</td>
|
666
755
|
</tr>
|
667
756
|
</table>
|
@@ -670,7 +759,7 @@
|
|
670
759
|
<div class="method_details ">
|
671
760
|
<h3 class="signature " id="index-instance_method">
|
672
761
|
|
673
|
-
- (<tt>
|
762
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
674
763
|
|
675
764
|
|
676
765
|
|
@@ -678,7 +767,10 @@
|
|
678
767
|
|
679
768
|
</h3><div class="docstring">
|
680
769
|
<div class="discussion">
|
681
|
-
|
770
|
+
<p>
|
771
|
+
First item: parsed data; second item: raw body
|
772
|
+
</p>
|
773
|
+
|
682
774
|
|
683
775
|
</div>
|
684
776
|
</div>
|
@@ -694,12 +786,13 @@
|
|
694
786
|
<span class='type'>(<tt>Hash</tt>)</span>
|
695
787
|
|
696
788
|
|
697
|
-
<em class="default">(defaults to: <tt>{
|
789
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
698
790
|
|
699
791
|
|
700
792
|
—
|
701
|
-
<div class='inline'>
|
702
|
-
|
793
|
+
<div class='inline'><p>
|
794
|
+
a hash of params to be passed to the service
|
795
|
+
</p>
|
703
796
|
</div>
|
704
797
|
|
705
798
|
</li>
|
@@ -712,12 +805,13 @@
|
|
712
805
|
<span class='type'>(<tt>Hash</tt>)</span>
|
713
806
|
|
714
807
|
|
715
|
-
<em class="default">(defaults to: <tt>{
|
808
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
716
809
|
|
717
810
|
|
718
811
|
—
|
719
|
-
<div class='inline'>
|
720
|
-
|
812
|
+
<div class='inline'><p>
|
813
|
+
additional http headers
|
814
|
+
</p>
|
721
815
|
</div>
|
722
816
|
|
723
817
|
</li>
|
@@ -737,8 +831,9 @@
|
|
737
831
|
|
738
832
|
</span>
|
739
833
|
|
740
|
-
— <div class='inline'>
|
741
|
-
|
834
|
+
— <div class='inline'><p>
|
835
|
+
For example, name asc, or name desc
|
836
|
+
</p>
|
742
837
|
</div>
|
743
838
|
|
744
839
|
</li>
|
@@ -750,8 +845,9 @@
|
|
750
845
|
|
751
846
|
</span>
|
752
847
|
|
753
|
-
— <div class='inline'>
|
754
|
-
|
848
|
+
— <div class='inline'><p>
|
849
|
+
Paginate results
|
850
|
+
</p>
|
755
851
|
</div>
|
756
852
|
|
757
853
|
</li>
|
@@ -763,8 +859,9 @@
|
|
763
859
|
|
764
860
|
</span>
|
765
861
|
|
766
|
-
— <div class='inline'>
|
767
|
-
|
862
|
+
— <div class='inline'><p>
|
863
|
+
Number of entries per request
|
864
|
+
</p>
|
768
865
|
</div>
|
769
866
|
|
770
867
|
</li>
|
@@ -776,8 +873,9 @@
|
|
776
873
|
|
777
874
|
</span>
|
778
875
|
|
779
|
-
— <div class='inline'>
|
780
|
-
|
876
|
+
— <div class='inline'><p>
|
877
|
+
Filter results
|
878
|
+
</p>
|
781
879
|
</div>
|
782
880
|
|
783
881
|
</li>
|
@@ -787,6 +885,25 @@
|
|
787
885
|
|
788
886
|
|
789
887
|
|
888
|
+
<p class="tag_title">Returns:</p>
|
889
|
+
<ul class="return">
|
890
|
+
|
891
|
+
<li>
|
892
|
+
|
893
|
+
|
894
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
895
|
+
|
896
|
+
|
897
|
+
|
898
|
+
—
|
899
|
+
<div class='inline'><p>
|
900
|
+
First item: parsed data; second item: raw body
|
901
|
+
</p>
|
902
|
+
</div>
|
903
|
+
|
904
|
+
</li>
|
905
|
+
|
906
|
+
</ul>
|
790
907
|
|
791
908
|
</div><table class="source_code">
|
792
909
|
<tr>
|
@@ -794,20 +911,17 @@
|
|
794
911
|
<pre class="lines">
|
795
912
|
|
796
913
|
|
797
|
-
15
|
798
914
|
16
|
799
915
|
17
|
800
|
-
18
|
801
|
-
19</pre>
|
916
|
+
18</pre>
|
802
917
|
</td>
|
803
918
|
<td>
|
804
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line
|
919
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 16</span>
|
805
920
|
|
806
|
-
<span class='kw'>def</span> <span class='
|
807
|
-
<span class='
|
808
|
-
|
809
|
-
|
810
|
-
<span class='kw'>end</span></pre>
|
921
|
+
<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>
|
922
|
+
<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>
|
923
|
+
<span class='rubyid_end end kw'>end</span>
|
924
|
+
</pre>
|
811
925
|
</td>
|
812
926
|
</tr>
|
813
927
|
</table>
|
@@ -816,7 +930,7 @@
|
|
816
930
|
<div class="method_details ">
|
817
931
|
<h3 class="signature " id="show-instance_method">
|
818
932
|
|
819
|
-
- (<tt>
|
933
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
820
934
|
|
821
935
|
|
822
936
|
|
@@ -824,7 +938,10 @@
|
|
824
938
|
|
825
939
|
</h3><div class="docstring">
|
826
940
|
<div class="discussion">
|
827
|
-
|
941
|
+
<p>
|
942
|
+
First item: parsed data; second item: raw body
|
943
|
+
</p>
|
944
|
+
|
828
945
|
|
829
946
|
</div>
|
830
947
|
</div>
|
@@ -840,12 +957,13 @@
|
|
840
957
|
<span class='type'>(<tt>Hash</tt>)</span>
|
841
958
|
|
842
959
|
|
843
|
-
<em class="default">(defaults to: <tt>{
|
960
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
844
961
|
|
845
962
|
|
846
963
|
—
|
847
|
-
<div class='inline'>
|
848
|
-
|
964
|
+
<div class='inline'><p>
|
965
|
+
a hash of params to be passed to the service
|
966
|
+
</p>
|
849
967
|
</div>
|
850
968
|
|
851
969
|
</li>
|
@@ -858,12 +976,13 @@
|
|
858
976
|
<span class='type'>(<tt>Hash</tt>)</span>
|
859
977
|
|
860
978
|
|
861
|
-
<em class="default">(defaults to: <tt>{
|
979
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
862
980
|
|
863
981
|
|
864
982
|
—
|
865
|
-
<div class='inline'>
|
866
|
-
|
983
|
+
<div class='inline'><p>
|
984
|
+
additional http headers
|
985
|
+
</p>
|
867
986
|
</div>
|
868
987
|
|
869
988
|
</li>
|
@@ -890,6 +1009,25 @@
|
|
890
1009
|
|
891
1010
|
|
892
1011
|
|
1012
|
+
<p class="tag_title">Returns:</p>
|
1013
|
+
<ul class="return">
|
1014
|
+
|
1015
|
+
<li>
|
1016
|
+
|
1017
|
+
|
1018
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1019
|
+
|
1020
|
+
|
1021
|
+
|
1022
|
+
—
|
1023
|
+
<div class='inline'><p>
|
1024
|
+
First item: parsed data; second item: raw body
|
1025
|
+
</p>
|
1026
|
+
</div>
|
1027
|
+
|
1028
|
+
</li>
|
1029
|
+
|
1030
|
+
</ul>
|
893
1031
|
|
894
1032
|
</div><table class="source_code">
|
895
1033
|
<tr>
|
@@ -899,18 +1037,15 @@
|
|
899
1037
|
|
900
1038
|
25
|
901
1039
|
26
|
902
|
-
27
|
903
|
-
28
|
904
|
-
29</pre>
|
1040
|
+
27</pre>
|
905
1041
|
</td>
|
906
1042
|
<td>
|
907
1043
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 25</span>
|
908
1044
|
|
909
|
-
<span class='kw'>def</span> <span class='
|
910
|
-
<span class='
|
911
|
-
|
912
|
-
|
913
|
-
<span class='kw'>end</span></pre>
|
1045
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</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>
|
1046
|
+
<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>
|
1047
|
+
<span class='rubyid_end end kw'>end</span>
|
1048
|
+
</pre>
|
914
1049
|
</td>
|
915
1050
|
</tr>
|
916
1051
|
</table>
|
@@ -919,7 +1054,7 @@
|
|
919
1054
|
<div class="method_details ">
|
920
1055
|
<h3 class="signature " id="update-instance_method">
|
921
1056
|
|
922
|
-
- (<tt>
|
1057
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
923
1058
|
|
924
1059
|
|
925
1060
|
|
@@ -927,7 +1062,10 @@
|
|
927
1062
|
|
928
1063
|
</h3><div class="docstring">
|
929
1064
|
<div class="discussion">
|
930
|
-
|
1065
|
+
<p>
|
1066
|
+
First item: parsed data; second item: raw body
|
1067
|
+
</p>
|
1068
|
+
|
931
1069
|
|
932
1070
|
</div>
|
933
1071
|
</div>
|
@@ -943,12 +1081,13 @@
|
|
943
1081
|
<span class='type'>(<tt>Hash</tt>)</span>
|
944
1082
|
|
945
1083
|
|
946
|
-
<em class="default">(defaults to: <tt>{
|
1084
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
947
1085
|
|
948
1086
|
|
949
1087
|
—
|
950
|
-
<div class='inline'>
|
951
|
-
|
1088
|
+
<div class='inline'><p>
|
1089
|
+
a hash of params to be passed to the service
|
1090
|
+
</p>
|
952
1091
|
</div>
|
953
1092
|
|
954
1093
|
</li>
|
@@ -961,12 +1100,13 @@
|
|
961
1100
|
<span class='type'>(<tt>Hash</tt>)</span>
|
962
1101
|
|
963
1102
|
|
964
|
-
<em class="default">(defaults to: <tt>{
|
1103
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
965
1104
|
|
966
1105
|
|
967
1106
|
—
|
968
|
-
<div class='inline'>
|
969
|
-
|
1107
|
+
<div class='inline'><p>
|
1108
|
+
additional http headers
|
1109
|
+
</p>
|
970
1110
|
</div>
|
971
1111
|
|
972
1112
|
</li>
|
@@ -995,19 +1135,26 @@
|
|
995
1135
|
|
996
1136
|
</span>
|
997
1137
|
|
998
|
-
— <div class='inline'>
|
999
|
-
|
1000
|
-
|
1001
|
-
<
|
1002
|
-
|
1003
|
-
|
1004
|
-
</li
|
1005
|
-
<
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
1009
|
-
|
1010
|
-
</li
|
1138
|
+
— <div class='inline'><p>
|
1139
|
+
allowed keys are:
|
1140
|
+
</p>
|
1141
|
+
<ul>
|
1142
|
+
<li>family [String]
|
1143
|
+
|
1144
|
+
</li>
|
1145
|
+
<li>major [String]
|
1146
|
+
|
1147
|
+
</li>
|
1148
|
+
<li>minor [String]
|
1149
|
+
|
1150
|
+
</li>
|
1151
|
+
<li>name [String]
|
1152
|
+
|
1153
|
+
</li>
|
1154
|
+
<li>release_name [String]
|
1155
|
+
|
1156
|
+
</li>
|
1157
|
+
</ul>
|
1011
1158
|
</div>
|
1012
1159
|
|
1013
1160
|
</li>
|
@@ -1017,6 +1164,25 @@
|
|
1017
1164
|
|
1018
1165
|
|
1019
1166
|
|
1167
|
+
<p class="tag_title">Returns:</p>
|
1168
|
+
<ul class="return">
|
1169
|
+
|
1170
|
+
<li>
|
1171
|
+
|
1172
|
+
|
1173
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1174
|
+
|
1175
|
+
|
1176
|
+
|
1177
|
+
—
|
1178
|
+
<div class='inline'><p>
|
1179
|
+
First item: parsed data; second item: raw body
|
1180
|
+
</p>
|
1181
|
+
</div>
|
1182
|
+
|
1183
|
+
</li>
|
1184
|
+
|
1185
|
+
</ul>
|
1020
1186
|
|
1021
1187
|
</div><table class="source_code">
|
1022
1188
|
<tr>
|
@@ -1024,20 +1190,17 @@
|
|
1024
1190
|
<pre class="lines">
|
1025
1191
|
|
1026
1192
|
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
61
|
1031
|
-
62</pre>
|
1193
|
+
56
|
1194
|
+
57
|
1195
|
+
58</pre>
|
1032
1196
|
</td>
|
1033
1197
|
<td>
|
1034
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line
|
1198
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 56</span>
|
1035
1199
|
|
1036
|
-
<span class='kw'>def</span> <span class='
|
1037
|
-
<span class='
|
1038
|
-
|
1039
|
-
|
1040
|
-
<span class='kw'>end</span></pre>
|
1200
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</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>
|
1201
|
+
<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>
|
1202
|
+
<span class='rubyid_end end kw'>end</span>
|
1203
|
+
</pre>
|
1041
1204
|
</td>
|
1042
1205
|
</tr>
|
1043
1206
|
</table>
|
@@ -1048,9 +1211,9 @@
|
|
1048
1211
|
</div>
|
1049
1212
|
|
1050
1213
|
<div id="footer">
|
1051
|
-
Generated on
|
1214
|
+
Generated on Tue Mar 19 09:50:28 2013 by
|
1052
1215
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1053
|
-
0.8.
|
1216
|
+
0.8.5.2 (ruby-1.8.7).
|
1054
1217
|
</div>
|
1055
1218
|
|
1056
1219
|
</body>
|