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::Ptable
|
|
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="#create-instance_method" title="#create (instance method)">- (
|
|
153
|
+
<a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</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="#destroy-instance_method" title="#destroy (instance method)">- (
|
|
178
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</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="#index-instance_method" title="#index (instance method)">- (
|
|
203
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</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="#show-instance_method" title="#show (instance method)">- (
|
|
228
|
+
<a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</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="#update-instance_method" title="#update (instance method)">- (
|
|
253
|
+
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</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
|
|
|
@@ -289,9 +304,10 @@
|
|
|
289
304
|
<td>
|
|
290
305
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line 4</span>
|
|
291
306
|
|
|
292
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='
|
|
293
|
-
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='
|
|
294
|
-
<span class='kw'>end</span
|
|
307
|
+
<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>
|
|
308
|
+
<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'>"ptables"</span><span class='rbrack token'>]</span>
|
|
309
|
+
<span class='rubyid_end end kw'>end</span>
|
|
310
|
+
</pre>
|
|
295
311
|
</td>
|
|
296
312
|
</tr>
|
|
297
313
|
</table>
|
|
@@ -306,7 +322,7 @@
|
|
|
306
322
|
<div class="method_details first">
|
|
307
323
|
<h3 class="signature first" id="create-instance_method">
|
|
308
324
|
|
|
309
|
-
- (<tt>
|
|
325
|
+
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
|
|
310
326
|
|
|
311
327
|
|
|
312
328
|
|
|
@@ -314,7 +330,10 @@
|
|
|
314
330
|
|
|
315
331
|
</h3><div class="docstring">
|
|
316
332
|
<div class="discussion">
|
|
317
|
-
|
|
333
|
+
<p>
|
|
334
|
+
First item: parsed data; second item: raw body
|
|
335
|
+
</p>
|
|
336
|
+
|
|
318
337
|
|
|
319
338
|
</div>
|
|
320
339
|
</div>
|
|
@@ -330,12 +349,13 @@
|
|
|
330
349
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
331
350
|
|
|
332
351
|
|
|
333
|
-
<em class="default">(defaults to: <tt>{
|
|
352
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
334
353
|
|
|
335
354
|
|
|
336
355
|
—
|
|
337
|
-
<div class='inline'>
|
|
338
|
-
|
|
356
|
+
<div class='inline'><p>
|
|
357
|
+
a hash of params to be passed to the service
|
|
358
|
+
</p>
|
|
339
359
|
</div>
|
|
340
360
|
|
|
341
361
|
</li>
|
|
@@ -348,12 +368,13 @@
|
|
|
348
368
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
349
369
|
|
|
350
370
|
|
|
351
|
-
<em class="default">(defaults to: <tt>{
|
|
371
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
352
372
|
|
|
353
373
|
|
|
354
374
|
—
|
|
355
|
-
<div class='inline'>
|
|
356
|
-
|
|
375
|
+
<div class='inline'><p>
|
|
376
|
+
additional http headers
|
|
377
|
+
</p>
|
|
357
378
|
</div>
|
|
358
379
|
|
|
359
380
|
</li>
|
|
@@ -373,15 +394,20 @@
|
|
|
373
394
|
|
|
374
395
|
</span>
|
|
375
396
|
|
|
376
|
-
— <div class='inline'>
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
<
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
</li
|
|
383
|
-
<
|
|
384
|
-
|
|
397
|
+
— <div class='inline'><p>
|
|
398
|
+
allowed keys are:
|
|
399
|
+
</p>
|
|
400
|
+
<ul>
|
|
401
|
+
<li>layout [String]
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
<li>name [String]
|
|
405
|
+
|
|
406
|
+
</li>
|
|
407
|
+
<li>os_family [String]
|
|
408
|
+
|
|
409
|
+
</li>
|
|
410
|
+
</ul>
|
|
385
411
|
</div>
|
|
386
412
|
|
|
387
413
|
</li>
|
|
@@ -391,6 +417,25 @@
|
|
|
391
417
|
|
|
392
418
|
|
|
393
419
|
|
|
420
|
+
<p class="tag_title">Returns:</p>
|
|
421
|
+
<ul class="return">
|
|
422
|
+
|
|
423
|
+
<li>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
—
|
|
431
|
+
<div class='inline'><p>
|
|
432
|
+
First item: parsed data; second item: raw body
|
|
433
|
+
</p>
|
|
434
|
+
</div>
|
|
435
|
+
|
|
436
|
+
</li>
|
|
437
|
+
|
|
438
|
+
</ul>
|
|
394
439
|
|
|
395
440
|
</div><table class="source_code">
|
|
396
441
|
<tr>
|
|
@@ -398,20 +443,17 @@
|
|
|
398
443
|
<pre class="lines">
|
|
399
444
|
|
|
400
445
|
|
|
446
|
+
38
|
|
401
447
|
39
|
|
402
|
-
40
|
|
403
|
-
41
|
|
404
|
-
42
|
|
405
|
-
43</pre>
|
|
448
|
+
40</pre>
|
|
406
449
|
</td>
|
|
407
450
|
<td>
|
|
408
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line
|
|
451
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line 38</span>
|
|
409
452
|
|
|
410
|
-
<span class='kw'>def</span> <span class='
|
|
411
|
-
<span class='
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
<span class='kw'>end</span></pre>
|
|
453
|
+
<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>
|
|
454
|
+
<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>
|
|
455
|
+
<span class='rubyid_end end kw'>end</span>
|
|
456
|
+
</pre>
|
|
415
457
|
</td>
|
|
416
458
|
</tr>
|
|
417
459
|
</table>
|
|
@@ -420,7 +462,7 @@
|
|
|
420
462
|
<div class="method_details ">
|
|
421
463
|
<h3 class="signature " id="destroy-instance_method">
|
|
422
464
|
|
|
423
|
-
- (<tt>
|
|
465
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
|
424
466
|
|
|
425
467
|
|
|
426
468
|
|
|
@@ -428,7 +470,10 @@
|
|
|
428
470
|
|
|
429
471
|
</h3><div class="docstring">
|
|
430
472
|
<div class="discussion">
|
|
431
|
-
|
|
473
|
+
<p>
|
|
474
|
+
First item: parsed data; second item: raw body
|
|
475
|
+
</p>
|
|
476
|
+
|
|
432
477
|
|
|
433
478
|
</div>
|
|
434
479
|
</div>
|
|
@@ -444,12 +489,13 @@
|
|
|
444
489
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
445
490
|
|
|
446
491
|
|
|
447
|
-
<em class="default">(defaults to: <tt>{
|
|
492
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
448
493
|
|
|
449
494
|
|
|
450
495
|
—
|
|
451
|
-
<div class='inline'>
|
|
452
|
-
|
|
496
|
+
<div class='inline'><p>
|
|
497
|
+
a hash of params to be passed to the service
|
|
498
|
+
</p>
|
|
453
499
|
</div>
|
|
454
500
|
|
|
455
501
|
</li>
|
|
@@ -462,12 +508,13 @@
|
|
|
462
508
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
463
509
|
|
|
464
510
|
|
|
465
|
-
<em class="default">(defaults to: <tt>{
|
|
511
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
466
512
|
|
|
467
513
|
|
|
468
514
|
—
|
|
469
|
-
<div class='inline'>
|
|
470
|
-
|
|
515
|
+
<div class='inline'><p>
|
|
516
|
+
additional http headers
|
|
517
|
+
</p>
|
|
471
518
|
</div>
|
|
472
519
|
|
|
473
520
|
</li>
|
|
@@ -494,6 +541,25 @@
|
|
|
494
541
|
|
|
495
542
|
|
|
496
543
|
|
|
544
|
+
<p class="tag_title">Returns:</p>
|
|
545
|
+
<ul class="return">
|
|
546
|
+
|
|
547
|
+
<li>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
—
|
|
555
|
+
<div class='inline'><p>
|
|
556
|
+
First item: parsed data; second item: raw body
|
|
557
|
+
</p>
|
|
558
|
+
</div>
|
|
559
|
+
|
|
560
|
+
</li>
|
|
561
|
+
|
|
562
|
+
</ul>
|
|
497
563
|
|
|
498
564
|
</div><table class="source_code">
|
|
499
565
|
<tr>
|
|
@@ -501,20 +567,17 @@
|
|
|
501
567
|
<pre class="lines">
|
|
502
568
|
|
|
503
569
|
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
67
|
|
508
|
-
68</pre>
|
|
570
|
+
61
|
|
571
|
+
62
|
|
572
|
+
63</pre>
|
|
509
573
|
</td>
|
|
510
574
|
<td>
|
|
511
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line
|
|
575
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line 61</span>
|
|
512
576
|
|
|
513
|
-
<span class='kw'>def</span> <span class='
|
|
514
|
-
<span class='
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
<span class='kw'>end</span></pre>
|
|
577
|
+
<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>
|
|
578
|
+
<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>
|
|
579
|
+
<span class='rubyid_end end kw'>end</span>
|
|
580
|
+
</pre>
|
|
518
581
|
</td>
|
|
519
582
|
</tr>
|
|
520
583
|
</table>
|
|
@@ -523,7 +586,7 @@
|
|
|
523
586
|
<div class="method_details ">
|
|
524
587
|
<h3 class="signature " id="index-instance_method">
|
|
525
588
|
|
|
526
|
-
- (<tt>
|
|
589
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
|
527
590
|
|
|
528
591
|
|
|
529
592
|
|
|
@@ -531,7 +594,10 @@
|
|
|
531
594
|
|
|
532
595
|
</h3><div class="docstring">
|
|
533
596
|
<div class="discussion">
|
|
534
|
-
|
|
597
|
+
<p>
|
|
598
|
+
First item: parsed data; second item: raw body
|
|
599
|
+
</p>
|
|
600
|
+
|
|
535
601
|
|
|
536
602
|
</div>
|
|
537
603
|
</div>
|
|
@@ -547,12 +613,13 @@
|
|
|
547
613
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
548
614
|
|
|
549
615
|
|
|
550
|
-
<em class="default">(defaults to: <tt>{
|
|
616
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
551
617
|
|
|
552
618
|
|
|
553
619
|
—
|
|
554
|
-
<div class='inline'>
|
|
555
|
-
|
|
620
|
+
<div class='inline'><p>
|
|
621
|
+
a hash of params to be passed to the service
|
|
622
|
+
</p>
|
|
556
623
|
</div>
|
|
557
624
|
|
|
558
625
|
</li>
|
|
@@ -565,12 +632,13 @@
|
|
|
565
632
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
566
633
|
|
|
567
634
|
|
|
568
|
-
<em class="default">(defaults to: <tt>{
|
|
635
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
569
636
|
|
|
570
637
|
|
|
571
638
|
—
|
|
572
|
-
<div class='inline'>
|
|
573
|
-
|
|
639
|
+
<div class='inline'><p>
|
|
640
|
+
additional http headers
|
|
641
|
+
</p>
|
|
574
642
|
</div>
|
|
575
643
|
|
|
576
644
|
</li>
|
|
@@ -590,8 +658,9 @@
|
|
|
590
658
|
|
|
591
659
|
</span>
|
|
592
660
|
|
|
593
|
-
— <div class='inline'>
|
|
594
|
-
|
|
661
|
+
— <div class='inline'><p>
|
|
662
|
+
Sort results
|
|
663
|
+
</p>
|
|
595
664
|
</div>
|
|
596
665
|
|
|
597
666
|
</li>
|
|
@@ -603,8 +672,9 @@
|
|
|
603
672
|
|
|
604
673
|
</span>
|
|
605
674
|
|
|
606
|
-
— <div class='inline'>
|
|
607
|
-
|
|
675
|
+
— <div class='inline'><p>
|
|
676
|
+
Paginate results
|
|
677
|
+
</p>
|
|
608
678
|
</div>
|
|
609
679
|
|
|
610
680
|
</li>
|
|
@@ -616,8 +686,9 @@
|
|
|
616
686
|
|
|
617
687
|
</span>
|
|
618
688
|
|
|
619
|
-
— <div class='inline'>
|
|
620
|
-
|
|
689
|
+
— <div class='inline'><p>
|
|
690
|
+
Number of entries per request
|
|
691
|
+
</p>
|
|
621
692
|
</div>
|
|
622
693
|
|
|
623
694
|
</li>
|
|
@@ -629,8 +700,9 @@
|
|
|
629
700
|
|
|
630
701
|
</span>
|
|
631
702
|
|
|
632
|
-
— <div class='inline'>
|
|
633
|
-
|
|
703
|
+
— <div class='inline'><p>
|
|
704
|
+
Filter results
|
|
705
|
+
</p>
|
|
634
706
|
</div>
|
|
635
707
|
|
|
636
708
|
</li>
|
|
@@ -640,6 +712,25 @@
|
|
|
640
712
|
|
|
641
713
|
|
|
642
714
|
|
|
715
|
+
<p class="tag_title">Returns:</p>
|
|
716
|
+
<ul class="return">
|
|
717
|
+
|
|
718
|
+
<li>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
—
|
|
726
|
+
<div class='inline'><p>
|
|
727
|
+
First item: parsed data; second item: raw body
|
|
728
|
+
</p>
|
|
729
|
+
</div>
|
|
730
|
+
|
|
731
|
+
</li>
|
|
732
|
+
|
|
733
|
+
</ul>
|
|
643
734
|
|
|
644
735
|
</div><table class="source_code">
|
|
645
736
|
<tr>
|
|
@@ -647,20 +738,17 @@
|
|
|
647
738
|
<pre class="lines">
|
|
648
739
|
|
|
649
740
|
|
|
650
|
-
15
|
|
651
741
|
16
|
|
652
742
|
17
|
|
653
|
-
18
|
|
654
|
-
19</pre>
|
|
743
|
+
18</pre>
|
|
655
744
|
</td>
|
|
656
745
|
<td>
|
|
657
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line
|
|
746
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line 16</span>
|
|
658
747
|
|
|
659
|
-
<span class='kw'>def</span> <span class='
|
|
660
|
-
<span class='
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
<span class='kw'>end</span></pre>
|
|
748
|
+
<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>
|
|
749
|
+
<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>
|
|
750
|
+
<span class='rubyid_end end kw'>end</span>
|
|
751
|
+
</pre>
|
|
664
752
|
</td>
|
|
665
753
|
</tr>
|
|
666
754
|
</table>
|
|
@@ -669,7 +757,7 @@
|
|
|
669
757
|
<div class="method_details ">
|
|
670
758
|
<h3 class="signature " id="show-instance_method">
|
|
671
759
|
|
|
672
|
-
- (<tt>
|
|
760
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
|
673
761
|
|
|
674
762
|
|
|
675
763
|
|
|
@@ -677,7 +765,10 @@
|
|
|
677
765
|
|
|
678
766
|
</h3><div class="docstring">
|
|
679
767
|
<div class="discussion">
|
|
680
|
-
|
|
768
|
+
<p>
|
|
769
|
+
First item: parsed data; second item: raw body
|
|
770
|
+
</p>
|
|
771
|
+
|
|
681
772
|
|
|
682
773
|
</div>
|
|
683
774
|
</div>
|
|
@@ -693,12 +784,13 @@
|
|
|
693
784
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
694
785
|
|
|
695
786
|
|
|
696
|
-
<em class="default">(defaults to: <tt>{
|
|
787
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
697
788
|
|
|
698
789
|
|
|
699
790
|
—
|
|
700
|
-
<div class='inline'>
|
|
701
|
-
|
|
791
|
+
<div class='inline'><p>
|
|
792
|
+
a hash of params to be passed to the service
|
|
793
|
+
</p>
|
|
702
794
|
</div>
|
|
703
795
|
|
|
704
796
|
</li>
|
|
@@ -711,12 +803,13 @@
|
|
|
711
803
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
712
804
|
|
|
713
805
|
|
|
714
|
-
<em class="default">(defaults to: <tt>{
|
|
806
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
715
807
|
|
|
716
808
|
|
|
717
809
|
—
|
|
718
|
-
<div class='inline'>
|
|
719
|
-
|
|
810
|
+
<div class='inline'><p>
|
|
811
|
+
additional http headers
|
|
812
|
+
</p>
|
|
720
813
|
</div>
|
|
721
814
|
|
|
722
815
|
</li>
|
|
@@ -743,6 +836,25 @@
|
|
|
743
836
|
|
|
744
837
|
|
|
745
838
|
|
|
839
|
+
<p class="tag_title">Returns:</p>
|
|
840
|
+
<ul class="return">
|
|
841
|
+
|
|
842
|
+
<li>
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
—
|
|
850
|
+
<div class='inline'><p>
|
|
851
|
+
First item: parsed data; second item: raw body
|
|
852
|
+
</p>
|
|
853
|
+
</div>
|
|
854
|
+
|
|
855
|
+
</li>
|
|
856
|
+
|
|
857
|
+
</ul>
|
|
746
858
|
|
|
747
859
|
</div><table class="source_code">
|
|
748
860
|
<tr>
|
|
@@ -752,18 +864,15 @@
|
|
|
752
864
|
|
|
753
865
|
25
|
|
754
866
|
26
|
|
755
|
-
27
|
|
756
|
-
28
|
|
757
|
-
29</pre>
|
|
867
|
+
27</pre>
|
|
758
868
|
</td>
|
|
759
869
|
<td>
|
|
760
870
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line 25</span>
|
|
761
871
|
|
|
762
|
-
<span class='kw'>def</span> <span class='
|
|
763
|
-
<span class='
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
<span class='kw'>end</span></pre>
|
|
872
|
+
<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>
|
|
873
|
+
<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>
|
|
874
|
+
<span class='rubyid_end end kw'>end</span>
|
|
875
|
+
</pre>
|
|
767
876
|
</td>
|
|
768
877
|
</tr>
|
|
769
878
|
</table>
|
|
@@ -772,7 +881,7 @@
|
|
|
772
881
|
<div class="method_details ">
|
|
773
882
|
<h3 class="signature " id="update-instance_method">
|
|
774
883
|
|
|
775
|
-
- (<tt>
|
|
884
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
|
776
885
|
|
|
777
886
|
|
|
778
887
|
|
|
@@ -780,7 +889,10 @@
|
|
|
780
889
|
|
|
781
890
|
</h3><div class="docstring">
|
|
782
891
|
<div class="discussion">
|
|
783
|
-
|
|
892
|
+
<p>
|
|
893
|
+
First item: parsed data; second item: raw body
|
|
894
|
+
</p>
|
|
895
|
+
|
|
784
896
|
|
|
785
897
|
</div>
|
|
786
898
|
</div>
|
|
@@ -796,12 +908,13 @@
|
|
|
796
908
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
797
909
|
|
|
798
910
|
|
|
799
|
-
<em class="default">(defaults to: <tt>{
|
|
911
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
800
912
|
|
|
801
913
|
|
|
802
914
|
—
|
|
803
|
-
<div class='inline'>
|
|
804
|
-
|
|
915
|
+
<div class='inline'><p>
|
|
916
|
+
a hash of params to be passed to the service
|
|
917
|
+
</p>
|
|
805
918
|
</div>
|
|
806
919
|
|
|
807
920
|
</li>
|
|
@@ -814,12 +927,13 @@
|
|
|
814
927
|
<span class='type'>(<tt>Hash</tt>)</span>
|
|
815
928
|
|
|
816
929
|
|
|
817
|
-
<em class="default">(defaults to: <tt>{
|
|
930
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
818
931
|
|
|
819
932
|
|
|
820
933
|
—
|
|
821
|
-
<div class='inline'>
|
|
822
|
-
|
|
934
|
+
<div class='inline'><p>
|
|
935
|
+
additional http headers
|
|
936
|
+
</p>
|
|
823
937
|
</div>
|
|
824
938
|
|
|
825
939
|
</li>
|
|
@@ -848,15 +962,20 @@
|
|
|
848
962
|
|
|
849
963
|
</span>
|
|
850
964
|
|
|
851
|
-
— <div class='inline'>
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
<
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
</li
|
|
858
|
-
<
|
|
859
|
-
|
|
965
|
+
— <div class='inline'><p>
|
|
966
|
+
allowed keys are:
|
|
967
|
+
</p>
|
|
968
|
+
<ul>
|
|
969
|
+
<li>layout [String]
|
|
970
|
+
|
|
971
|
+
</li>
|
|
972
|
+
<li>name [String]
|
|
973
|
+
|
|
974
|
+
</li>
|
|
975
|
+
<li>os_family [String]
|
|
976
|
+
|
|
977
|
+
</li>
|
|
978
|
+
</ul>
|
|
860
979
|
</div>
|
|
861
980
|
|
|
862
981
|
</li>
|
|
@@ -866,6 +985,25 @@
|
|
|
866
985
|
|
|
867
986
|
|
|
868
987
|
|
|
988
|
+
<p class="tag_title">Returns:</p>
|
|
989
|
+
<ul class="return">
|
|
990
|
+
|
|
991
|
+
<li>
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
—
|
|
999
|
+
<div class='inline'><p>
|
|
1000
|
+
First item: parsed data; second item: raw body
|
|
1001
|
+
</p>
|
|
1002
|
+
</div>
|
|
1003
|
+
|
|
1004
|
+
</li>
|
|
1005
|
+
|
|
1006
|
+
</ul>
|
|
869
1007
|
|
|
870
1008
|
</div><table class="source_code">
|
|
871
1009
|
<tr>
|
|
@@ -873,20 +1011,17 @@
|
|
|
873
1011
|
<pre class="lines">
|
|
874
1012
|
|
|
875
1013
|
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
57
|
|
880
|
-
58</pre>
|
|
1014
|
+
52
|
|
1015
|
+
53
|
|
1016
|
+
54</pre>
|
|
881
1017
|
</td>
|
|
882
1018
|
<td>
|
|
883
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line
|
|
1019
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/ptable.rb', line 52</span>
|
|
884
1020
|
|
|
885
|
-
<span class='kw'>def</span> <span class='
|
|
886
|
-
<span class='
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
<span class='kw'>end</span></pre>
|
|
1021
|
+
<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>
|
|
1022
|
+
<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>
|
|
1023
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1024
|
+
</pre>
|
|
890
1025
|
</td>
|
|
891
1026
|
</tr>
|
|
892
1027
|
</table>
|
|
@@ -897,9 +1032,9 @@
|
|
|
897
1032
|
</div>
|
|
898
1033
|
|
|
899
1034
|
<div id="footer">
|
|
900
|
-
Generated on
|
|
1035
|
+
Generated on Tue Mar 19 09:50:24 2013 by
|
|
901
1036
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
902
|
-
0.8.
|
|
1037
|
+
0.8.5.2 (ruby-1.8.7).
|
|
903
1038
|
</div>
|
|
904
1039
|
|
|
905
1040
|
</body>
|