foreman_api 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- 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::LookupKey
|
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/lookup_key.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'>"lookup_keys"</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,21 +394,29 @@
|
|
373
394
|
|
374
395
|
</span>
|
375
396
|
|
376
|
-
— <div class='inline'>
|
377
|
-
|
378
|
-
|
379
|
-
<
|
380
|
-
|
381
|
-
|
382
|
-
</li
|
383
|
-
<
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
</li
|
389
|
-
<
|
390
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>puppetclass_id [String]
|
402
|
+
|
403
|
+
</li>
|
404
|
+
<li>default_value [String]
|
405
|
+
|
406
|
+
</li>
|
407
|
+
<li>description [String]
|
408
|
+
|
409
|
+
</li>
|
410
|
+
<li>key [String]
|
411
|
+
|
412
|
+
</li>
|
413
|
+
<li>lookup_values_count [String]
|
414
|
+
|
415
|
+
</li>
|
416
|
+
<li>path [String]
|
417
|
+
|
418
|
+
</li>
|
419
|
+
</ul>
|
391
420
|
</div>
|
392
421
|
|
393
422
|
</li>
|
@@ -397,6 +426,25 @@
|
|
397
426
|
|
398
427
|
|
399
428
|
|
429
|
+
<p class="tag_title">Returns:</p>
|
430
|
+
<ul class="return">
|
431
|
+
|
432
|
+
<li>
|
433
|
+
|
434
|
+
|
435
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
—
|
440
|
+
<div class='inline'><p>
|
441
|
+
First item: parsed data; second item: raw body
|
442
|
+
</p>
|
443
|
+
</div>
|
444
|
+
|
445
|
+
</li>
|
446
|
+
|
447
|
+
</ul>
|
400
448
|
|
401
449
|
</div><table class="source_code">
|
402
450
|
<tr>
|
@@ -406,18 +454,15 @@
|
|
406
454
|
|
407
455
|
42
|
408
456
|
43
|
409
|
-
44
|
410
|
-
45
|
411
|
-
46</pre>
|
457
|
+
44</pre>
|
412
458
|
</td>
|
413
459
|
<td>
|
414
460
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line 42</span>
|
415
461
|
|
416
|
-
<span class='kw'>def</span> <span class='
|
417
|
-
<span class='
|
418
|
-
|
419
|
-
|
420
|
-
<span class='kw'>end</span></pre>
|
462
|
+
<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>
|
463
|
+
<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>
|
464
|
+
<span class='rubyid_end end kw'>end</span>
|
465
|
+
</pre>
|
421
466
|
</td>
|
422
467
|
</tr>
|
423
468
|
</table>
|
@@ -426,7 +471,7 @@
|
|
426
471
|
<div class="method_details ">
|
427
472
|
<h3 class="signature " id="destroy-instance_method">
|
428
473
|
|
429
|
-
- (<tt>
|
474
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
430
475
|
|
431
476
|
|
432
477
|
|
@@ -434,7 +479,10 @@
|
|
434
479
|
|
435
480
|
</h3><div class="docstring">
|
436
481
|
<div class="discussion">
|
437
|
-
|
482
|
+
<p>
|
483
|
+
First item: parsed data; second item: raw body
|
484
|
+
</p>
|
485
|
+
|
438
486
|
|
439
487
|
</div>
|
440
488
|
</div>
|
@@ -450,12 +498,13 @@
|
|
450
498
|
<span class='type'>(<tt>Hash</tt>)</span>
|
451
499
|
|
452
500
|
|
453
|
-
<em class="default">(defaults to: <tt>{
|
501
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
454
502
|
|
455
503
|
|
456
504
|
—
|
457
|
-
<div class='inline'>
|
458
|
-
|
505
|
+
<div class='inline'><p>
|
506
|
+
a hash of params to be passed to the service
|
507
|
+
</p>
|
459
508
|
</div>
|
460
509
|
|
461
510
|
</li>
|
@@ -468,12 +517,13 @@
|
|
468
517
|
<span class='type'>(<tt>Hash</tt>)</span>
|
469
518
|
|
470
519
|
|
471
|
-
<em class="default">(defaults to: <tt>{
|
520
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
472
521
|
|
473
522
|
|
474
523
|
—
|
475
|
-
<div class='inline'>
|
476
|
-
|
524
|
+
<div class='inline'><p>
|
525
|
+
additional http headers
|
526
|
+
</p>
|
477
527
|
</div>
|
478
528
|
|
479
529
|
</li>
|
@@ -500,6 +550,25 @@
|
|
500
550
|
|
501
551
|
|
502
552
|
|
553
|
+
<p class="tag_title">Returns:</p>
|
554
|
+
<ul class="return">
|
555
|
+
|
556
|
+
<li>
|
557
|
+
|
558
|
+
|
559
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
—
|
564
|
+
<div class='inline'><p>
|
565
|
+
First item: parsed data; second item: raw body
|
566
|
+
</p>
|
567
|
+
</div>
|
568
|
+
|
569
|
+
</li>
|
570
|
+
|
571
|
+
</ul>
|
503
572
|
|
504
573
|
</div><table class="source_code">
|
505
574
|
<tr>
|
@@ -507,20 +576,17 @@
|
|
507
576
|
<pre class="lines">
|
508
577
|
|
509
578
|
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
73
|
514
|
-
74</pre>
|
579
|
+
68
|
580
|
+
69
|
581
|
+
70</pre>
|
515
582
|
</td>
|
516
583
|
<td>
|
517
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line
|
584
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line 68</span>
|
518
585
|
|
519
|
-
<span class='kw'>def</span> <span class='
|
520
|
-
<span class='
|
521
|
-
|
522
|
-
|
523
|
-
<span class='kw'>end</span></pre>
|
586
|
+
<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>
|
587
|
+
<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>
|
588
|
+
<span class='rubyid_end end kw'>end</span>
|
589
|
+
</pre>
|
524
590
|
</td>
|
525
591
|
</tr>
|
526
592
|
</table>
|
@@ -529,7 +595,7 @@
|
|
529
595
|
<div class="method_details ">
|
530
596
|
<h3 class="signature " id="index-instance_method">
|
531
597
|
|
532
|
-
- (<tt>
|
598
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
533
599
|
|
534
600
|
|
535
601
|
|
@@ -537,7 +603,10 @@
|
|
537
603
|
|
538
604
|
</h3><div class="docstring">
|
539
605
|
<div class="discussion">
|
540
|
-
|
606
|
+
<p>
|
607
|
+
First item: parsed data; second item: raw body
|
608
|
+
</p>
|
609
|
+
|
541
610
|
|
542
611
|
</div>
|
543
612
|
</div>
|
@@ -553,12 +622,13 @@
|
|
553
622
|
<span class='type'>(<tt>Hash</tt>)</span>
|
554
623
|
|
555
624
|
|
556
|
-
<em class="default">(defaults to: <tt>{
|
625
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
557
626
|
|
558
627
|
|
559
628
|
—
|
560
|
-
<div class='inline'>
|
561
|
-
|
629
|
+
<div class='inline'><p>
|
630
|
+
a hash of params to be passed to the service
|
631
|
+
</p>
|
562
632
|
</div>
|
563
633
|
|
564
634
|
</li>
|
@@ -571,12 +641,13 @@
|
|
571
641
|
<span class='type'>(<tt>Hash</tt>)</span>
|
572
642
|
|
573
643
|
|
574
|
-
<em class="default">(defaults to: <tt>{
|
644
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
575
645
|
|
576
646
|
|
577
647
|
—
|
578
|
-
<div class='inline'>
|
579
|
-
|
648
|
+
<div class='inline'><p>
|
649
|
+
additional http headers
|
650
|
+
</p>
|
580
651
|
</div>
|
581
652
|
|
582
653
|
</li>
|
@@ -589,6 +660,20 @@
|
|
589
660
|
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
590
661
|
<ul class="option">
|
591
662
|
|
663
|
+
<li>
|
664
|
+
<span class="name">host_id</span>
|
665
|
+
<span class="type">(<tt>Object</tt>)</span>
|
666
|
+
<span class="default">
|
667
|
+
|
668
|
+
</span>
|
669
|
+
|
670
|
+
— <div class='inline'><p>
|
671
|
+
Part of <tt>/api/hosts/:host_id/lookup_keys</tt> path
|
672
|
+
</p>
|
673
|
+
</div>
|
674
|
+
|
675
|
+
</li>
|
676
|
+
|
592
677
|
<li>
|
593
678
|
<span class="name">order</span>
|
594
679
|
<span class="type">(<tt>String</tt>)</span>
|
@@ -596,8 +681,9 @@
|
|
596
681
|
|
597
682
|
</span>
|
598
683
|
|
599
|
-
— <div class='inline'>
|
600
|
-
|
684
|
+
— <div class='inline'><p>
|
685
|
+
Sort results
|
686
|
+
</p>
|
601
687
|
</div>
|
602
688
|
|
603
689
|
</li>
|
@@ -609,8 +695,9 @@
|
|
609
695
|
|
610
696
|
</span>
|
611
697
|
|
612
|
-
— <div class='inline'>
|
613
|
-
|
698
|
+
— <div class='inline'><p>
|
699
|
+
Paginate results
|
700
|
+
</p>
|
614
701
|
</div>
|
615
702
|
|
616
703
|
</li>
|
@@ -622,8 +709,9 @@
|
|
622
709
|
|
623
710
|
</span>
|
624
711
|
|
625
|
-
— <div class='inline'>
|
626
|
-
|
712
|
+
— <div class='inline'><p>
|
713
|
+
Number of entries per request
|
714
|
+
</p>
|
627
715
|
</div>
|
628
716
|
|
629
717
|
</li>
|
@@ -635,8 +723,9 @@
|
|
635
723
|
|
636
724
|
</span>
|
637
725
|
|
638
|
-
— <div class='inline'>
|
639
|
-
|
726
|
+
— <div class='inline'><p>
|
727
|
+
Filter results
|
728
|
+
</p>
|
640
729
|
</div>
|
641
730
|
|
642
731
|
</li>
|
@@ -646,6 +735,25 @@
|
|
646
735
|
|
647
736
|
|
648
737
|
|
738
|
+
<p class="tag_title">Returns:</p>
|
739
|
+
<ul class="return">
|
740
|
+
|
741
|
+
<li>
|
742
|
+
|
743
|
+
|
744
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
745
|
+
|
746
|
+
|
747
|
+
|
748
|
+
—
|
749
|
+
<div class='inline'><p>
|
750
|
+
First item: parsed data; second item: raw body
|
751
|
+
</p>
|
752
|
+
</div>
|
753
|
+
|
754
|
+
</li>
|
755
|
+
|
756
|
+
</ul>
|
649
757
|
|
650
758
|
</div><table class="source_code">
|
651
759
|
<tr>
|
@@ -653,20 +761,17 @@
|
|
653
761
|
<pre class="lines">
|
654
762
|
|
655
763
|
|
656
|
-
15
|
657
|
-
16
|
658
764
|
17
|
659
765
|
18
|
660
766
|
19</pre>
|
661
767
|
</td>
|
662
768
|
<td>
|
663
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line
|
769
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line 17</span>
|
664
770
|
|
665
|
-
<span class='kw'>def</span> <span class='
|
666
|
-
<span class='
|
667
|
-
|
668
|
-
|
669
|
-
<span class='kw'>end</span></pre>
|
771
|
+
<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>
|
772
|
+
<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>
|
773
|
+
<span class='rubyid_end end kw'>end</span>
|
774
|
+
</pre>
|
670
775
|
</td>
|
671
776
|
</tr>
|
672
777
|
</table>
|
@@ -675,7 +780,7 @@
|
|
675
780
|
<div class="method_details ">
|
676
781
|
<h3 class="signature " id="show-instance_method">
|
677
782
|
|
678
|
-
- (<tt>
|
783
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
679
784
|
|
680
785
|
|
681
786
|
|
@@ -683,7 +788,10 @@
|
|
683
788
|
|
684
789
|
</h3><div class="docstring">
|
685
790
|
<div class="discussion">
|
686
|
-
|
791
|
+
<p>
|
792
|
+
First item: parsed data; second item: raw body
|
793
|
+
</p>
|
794
|
+
|
687
795
|
|
688
796
|
</div>
|
689
797
|
</div>
|
@@ -699,12 +807,13 @@
|
|
699
807
|
<span class='type'>(<tt>Hash</tt>)</span>
|
700
808
|
|
701
809
|
|
702
|
-
<em class="default">(defaults to: <tt>{
|
810
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
703
811
|
|
704
812
|
|
705
813
|
—
|
706
|
-
<div class='inline'>
|
707
|
-
|
814
|
+
<div class='inline'><p>
|
815
|
+
a hash of params to be passed to the service
|
816
|
+
</p>
|
708
817
|
</div>
|
709
818
|
|
710
819
|
</li>
|
@@ -717,12 +826,13 @@
|
|
717
826
|
<span class='type'>(<tt>Hash</tt>)</span>
|
718
827
|
|
719
828
|
|
720
|
-
<em class="default">(defaults to: <tt>{
|
829
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
721
830
|
|
722
831
|
|
723
832
|
—
|
724
|
-
<div class='inline'>
|
725
|
-
|
833
|
+
<div class='inline'><p>
|
834
|
+
additional http headers
|
835
|
+
</p>
|
726
836
|
</div>
|
727
837
|
|
728
838
|
</li>
|
@@ -749,6 +859,25 @@
|
|
749
859
|
|
750
860
|
|
751
861
|
|
862
|
+
<p class="tag_title">Returns:</p>
|
863
|
+
<ul class="return">
|
864
|
+
|
865
|
+
<li>
|
866
|
+
|
867
|
+
|
868
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
—
|
873
|
+
<div class='inline'><p>
|
874
|
+
First item: parsed data; second item: raw body
|
875
|
+
</p>
|
876
|
+
</div>
|
877
|
+
|
878
|
+
</li>
|
879
|
+
|
880
|
+
</ul>
|
752
881
|
|
753
882
|
</div><table class="source_code">
|
754
883
|
<tr>
|
@@ -756,20 +885,17 @@
|
|
756
885
|
<pre class="lines">
|
757
886
|
|
758
887
|
|
759
|
-
25
|
760
888
|
26
|
761
889
|
27
|
762
|
-
28
|
763
|
-
29</pre>
|
890
|
+
28</pre>
|
764
891
|
</td>
|
765
892
|
<td>
|
766
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line
|
893
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line 26</span>
|
767
894
|
|
768
|
-
<span class='kw'>def</span> <span class='
|
769
|
-
<span class='
|
770
|
-
|
771
|
-
|
772
|
-
<span class='kw'>end</span></pre>
|
895
|
+
<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>
|
896
|
+
<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>
|
897
|
+
<span class='rubyid_end end kw'>end</span>
|
898
|
+
</pre>
|
773
899
|
</td>
|
774
900
|
</tr>
|
775
901
|
</table>
|
@@ -778,7 +904,7 @@
|
|
778
904
|
<div class="method_details ">
|
779
905
|
<h3 class="signature " id="update-instance_method">
|
780
906
|
|
781
|
-
- (<tt>
|
907
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
782
908
|
|
783
909
|
|
784
910
|
|
@@ -786,7 +912,10 @@
|
|
786
912
|
|
787
913
|
</h3><div class="docstring">
|
788
914
|
<div class="discussion">
|
789
|
-
|
915
|
+
<p>
|
916
|
+
First item: parsed data; second item: raw body
|
917
|
+
</p>
|
918
|
+
|
790
919
|
|
791
920
|
</div>
|
792
921
|
</div>
|
@@ -802,12 +931,13 @@
|
|
802
931
|
<span class='type'>(<tt>Hash</tt>)</span>
|
803
932
|
|
804
933
|
|
805
|
-
<em class="default">(defaults to: <tt>{
|
934
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
806
935
|
|
807
936
|
|
808
937
|
—
|
809
|
-
<div class='inline'>
|
810
|
-
|
938
|
+
<div class='inline'><p>
|
939
|
+
a hash of params to be passed to the service
|
940
|
+
</p>
|
811
941
|
</div>
|
812
942
|
|
813
943
|
</li>
|
@@ -820,12 +950,13 @@
|
|
820
950
|
<span class='type'>(<tt>Hash</tt>)</span>
|
821
951
|
|
822
952
|
|
823
|
-
<em class="default">(defaults to: <tt>{
|
953
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
824
954
|
|
825
955
|
|
826
956
|
—
|
827
|
-
<div class='inline'>
|
828
|
-
|
957
|
+
<div class='inline'><p>
|
958
|
+
additional http headers
|
959
|
+
</p>
|
829
960
|
</div>
|
830
961
|
|
831
962
|
</li>
|
@@ -854,21 +985,29 @@
|
|
854
985
|
|
855
986
|
</span>
|
856
987
|
|
857
|
-
— <div class='inline'>
|
858
|
-
|
859
|
-
|
860
|
-
<
|
861
|
-
|
862
|
-
|
863
|
-
</li
|
864
|
-
<
|
865
|
-
|
866
|
-
|
867
|
-
|
868
|
-
|
869
|
-
</li
|
870
|
-
<
|
871
|
-
|
988
|
+
— <div class='inline'><p>
|
989
|
+
allowed keys are:
|
990
|
+
</p>
|
991
|
+
<ul>
|
992
|
+
<li>puppetclass_id [String]
|
993
|
+
|
994
|
+
</li>
|
995
|
+
<li>default_value [String]
|
996
|
+
|
997
|
+
</li>
|
998
|
+
<li>description [String]
|
999
|
+
|
1000
|
+
</li>
|
1001
|
+
<li>key [String]
|
1002
|
+
|
1003
|
+
</li>
|
1004
|
+
<li>lookup_values_count [String]
|
1005
|
+
|
1006
|
+
</li>
|
1007
|
+
<li>path [String]
|
1008
|
+
|
1009
|
+
</li>
|
1010
|
+
</ul>
|
872
1011
|
</div>
|
873
1012
|
|
874
1013
|
</li>
|
@@ -878,6 +1017,25 @@
|
|
878
1017
|
|
879
1018
|
|
880
1019
|
|
1020
|
+
<p class="tag_title">Returns:</p>
|
1021
|
+
<ul class="return">
|
1022
|
+
|
1023
|
+
<li>
|
1024
|
+
|
1025
|
+
|
1026
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1027
|
+
|
1028
|
+
|
1029
|
+
|
1030
|
+
—
|
1031
|
+
<div class='inline'><p>
|
1032
|
+
First item: parsed data; second item: raw body
|
1033
|
+
</p>
|
1034
|
+
</div>
|
1035
|
+
|
1036
|
+
</li>
|
1037
|
+
|
1038
|
+
</ul>
|
881
1039
|
|
882
1040
|
</div><table class="source_code">
|
883
1041
|
<tr>
|
@@ -885,20 +1043,17 @@
|
|
885
1043
|
<pre class="lines">
|
886
1044
|
|
887
1045
|
|
1046
|
+
59
|
888
1047
|
60
|
889
|
-
61
|
890
|
-
62
|
891
|
-
63
|
892
|
-
64</pre>
|
1048
|
+
61</pre>
|
893
1049
|
</td>
|
894
1050
|
<td>
|
895
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line
|
1051
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/lookup_key.rb', line 59</span>
|
896
1052
|
|
897
|
-
<span class='kw'>def</span> <span class='
|
898
|
-
<span class='
|
899
|
-
|
900
|
-
|
901
|
-
<span class='kw'>end</span></pre>
|
1053
|
+
<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>
|
1054
|
+
<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>
|
1055
|
+
<span class='rubyid_end end kw'>end</span>
|
1056
|
+
</pre>
|
902
1057
|
</td>
|
903
1058
|
</tr>
|
904
1059
|
</table>
|
@@ -909,9 +1064,9 @@
|
|
909
1064
|
</div>
|
910
1065
|
|
911
1066
|
<div id="footer">
|
912
|
-
Generated on
|
1067
|
+
Generated on Tue Mar 19 09:50:26 2013 by
|
913
1068
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
914
|
-
0.8.
|
1069
|
+
0.8.5.2 (ruby-1.8.7).
|
915
1070
|
</div>
|
916
1071
|
|
917
1072
|
</body>
|