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::Usergroup
|
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/usergroup.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'>"usergroups"</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,11 +394,14 @@
|
|
373
394
|
|
374
395
|
</span>
|
375
396
|
|
376
|
-
— <div class='inline'>
|
377
|
-
|
378
|
-
|
379
|
-
<
|
380
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>name [String]
|
402
|
+
|
403
|
+
</li>
|
404
|
+
</ul>
|
381
405
|
</div>
|
382
406
|
|
383
407
|
</li>
|
@@ -387,6 +411,25 @@
|
|
387
411
|
|
388
412
|
|
389
413
|
|
414
|
+
<p class="tag_title">Returns:</p>
|
415
|
+
<ul class="return">
|
416
|
+
|
417
|
+
<li>
|
418
|
+
|
419
|
+
|
420
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
—
|
425
|
+
<div class='inline'><p>
|
426
|
+
First item: parsed data; second item: raw body
|
427
|
+
</p>
|
428
|
+
</div>
|
429
|
+
|
430
|
+
</li>
|
431
|
+
|
432
|
+
</ul>
|
390
433
|
|
391
434
|
</div><table class="source_code">
|
392
435
|
<tr>
|
@@ -394,20 +437,17 @@
|
|
394
437
|
<pre class="lines">
|
395
438
|
|
396
439
|
|
397
|
-
35
|
398
440
|
36
|
399
441
|
37
|
400
|
-
38
|
401
|
-
39</pre>
|
442
|
+
38</pre>
|
402
443
|
</td>
|
403
444
|
<td>
|
404
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line
|
445
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line 36</span>
|
405
446
|
|
406
|
-
<span class='kw'>def</span> <span class='
|
407
|
-
<span class='
|
408
|
-
|
409
|
-
|
410
|
-
<span class='kw'>end</span></pre>
|
447
|
+
<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>
|
448
|
+
<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>
|
449
|
+
<span class='rubyid_end end kw'>end</span>
|
450
|
+
</pre>
|
411
451
|
</td>
|
412
452
|
</tr>
|
413
453
|
</table>
|
@@ -416,7 +456,7 @@
|
|
416
456
|
<div class="method_details ">
|
417
457
|
<h3 class="signature " id="destroy-instance_method">
|
418
458
|
|
419
|
-
- (<tt>
|
459
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
420
460
|
|
421
461
|
|
422
462
|
|
@@ -424,7 +464,10 @@
|
|
424
464
|
|
425
465
|
</h3><div class="docstring">
|
426
466
|
<div class="discussion">
|
427
|
-
|
467
|
+
<p>
|
468
|
+
First item: parsed data; second item: raw body
|
469
|
+
</p>
|
470
|
+
|
428
471
|
|
429
472
|
</div>
|
430
473
|
</div>
|
@@ -440,12 +483,13 @@
|
|
440
483
|
<span class='type'>(<tt>Hash</tt>)</span>
|
441
484
|
|
442
485
|
|
443
|
-
<em class="default">(defaults to: <tt>{
|
486
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
444
487
|
|
445
488
|
|
446
489
|
—
|
447
|
-
<div class='inline'>
|
448
|
-
|
490
|
+
<div class='inline'><p>
|
491
|
+
a hash of params to be passed to the service
|
492
|
+
</p>
|
449
493
|
</div>
|
450
494
|
|
451
495
|
</li>
|
@@ -458,12 +502,13 @@
|
|
458
502
|
<span class='type'>(<tt>Hash</tt>)</span>
|
459
503
|
|
460
504
|
|
461
|
-
<em class="default">(defaults to: <tt>{
|
505
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
462
506
|
|
463
507
|
|
464
508
|
—
|
465
|
-
<div class='inline'>
|
466
|
-
|
509
|
+
<div class='inline'><p>
|
510
|
+
additional http headers
|
511
|
+
</p>
|
467
512
|
</div>
|
468
513
|
|
469
514
|
</li>
|
@@ -490,6 +535,25 @@
|
|
490
535
|
|
491
536
|
|
492
537
|
|
538
|
+
<p class="tag_title">Returns:</p>
|
539
|
+
<ul class="return">
|
540
|
+
|
541
|
+
<li>
|
542
|
+
|
543
|
+
|
544
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
545
|
+
|
546
|
+
|
547
|
+
|
548
|
+
—
|
549
|
+
<div class='inline'><p>
|
550
|
+
First item: parsed data; second item: raw body
|
551
|
+
</p>
|
552
|
+
</div>
|
553
|
+
|
554
|
+
</li>
|
555
|
+
|
556
|
+
</ul>
|
493
557
|
|
494
558
|
</div><table class="source_code">
|
495
559
|
<tr>
|
@@ -497,20 +561,17 @@
|
|
497
561
|
<pre class="lines">
|
498
562
|
|
499
563
|
|
564
|
+
57
|
500
565
|
58
|
501
|
-
59
|
502
|
-
60
|
503
|
-
61
|
504
|
-
62</pre>
|
566
|
+
59</pre>
|
505
567
|
</td>
|
506
568
|
<td>
|
507
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line
|
569
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line 57</span>
|
508
570
|
|
509
|
-
<span class='kw'>def</span> <span class='
|
510
|
-
<span class='
|
511
|
-
|
512
|
-
|
513
|
-
<span class='kw'>end</span></pre>
|
571
|
+
<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>
|
572
|
+
<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>
|
573
|
+
<span class='rubyid_end end kw'>end</span>
|
574
|
+
</pre>
|
514
575
|
</td>
|
515
576
|
</tr>
|
516
577
|
</table>
|
@@ -519,7 +580,7 @@
|
|
519
580
|
<div class="method_details ">
|
520
581
|
<h3 class="signature " id="index-instance_method">
|
521
582
|
|
522
|
-
- (<tt>
|
583
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
523
584
|
|
524
585
|
|
525
586
|
|
@@ -527,7 +588,10 @@
|
|
527
588
|
|
528
589
|
</h3><div class="docstring">
|
529
590
|
<div class="discussion">
|
530
|
-
|
591
|
+
<p>
|
592
|
+
First item: parsed data; second item: raw body
|
593
|
+
</p>
|
594
|
+
|
531
595
|
|
532
596
|
</div>
|
533
597
|
</div>
|
@@ -543,12 +607,13 @@
|
|
543
607
|
<span class='type'>(<tt>Hash</tt>)</span>
|
544
608
|
|
545
609
|
|
546
|
-
<em class="default">(defaults to: <tt>{
|
610
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
547
611
|
|
548
612
|
|
549
613
|
—
|
550
|
-
<div class='inline'>
|
551
|
-
|
614
|
+
<div class='inline'><p>
|
615
|
+
a hash of params to be passed to the service
|
616
|
+
</p>
|
552
617
|
</div>
|
553
618
|
|
554
619
|
</li>
|
@@ -561,12 +626,13 @@
|
|
561
626
|
<span class='type'>(<tt>Hash</tt>)</span>
|
562
627
|
|
563
628
|
|
564
|
-
<em class="default">(defaults to: <tt>{
|
629
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
565
630
|
|
566
631
|
|
567
632
|
—
|
568
|
-
<div class='inline'>
|
569
|
-
|
633
|
+
<div class='inline'><p>
|
634
|
+
additional http headers
|
635
|
+
</p>
|
570
636
|
</div>
|
571
637
|
|
572
638
|
</li>
|
@@ -579,6 +645,20 @@
|
|
579
645
|
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
580
646
|
<ul class="option">
|
581
647
|
|
648
|
+
<li>
|
649
|
+
<span class="name">order</span>
|
650
|
+
<span class="type">(<tt>String</tt>)</span>
|
651
|
+
<span class="default">
|
652
|
+
|
653
|
+
</span>
|
654
|
+
|
655
|
+
— <div class='inline'><p>
|
656
|
+
Sort results
|
657
|
+
</p>
|
658
|
+
</div>
|
659
|
+
|
660
|
+
</li>
|
661
|
+
|
582
662
|
<li>
|
583
663
|
<span class="name">page</span>
|
584
664
|
<span class="type">(<tt>String</tt>)</span>
|
@@ -586,8 +666,9 @@
|
|
586
666
|
|
587
667
|
</span>
|
588
668
|
|
589
|
-
— <div class='inline'>
|
590
|
-
|
669
|
+
— <div class='inline'><p>
|
670
|
+
Paginate results
|
671
|
+
</p>
|
591
672
|
</div>
|
592
673
|
|
593
674
|
</li>
|
@@ -599,8 +680,23 @@
|
|
599
680
|
|
600
681
|
</span>
|
601
682
|
|
602
|
-
— <div class='inline'>
|
603
|
-
|
683
|
+
— <div class='inline'><p>
|
684
|
+
Number of entries per request
|
685
|
+
</p>
|
686
|
+
</div>
|
687
|
+
|
688
|
+
</li>
|
689
|
+
|
690
|
+
<li>
|
691
|
+
<span class="name">search</span>
|
692
|
+
<span class="type">(<tt>String</tt>)</span>
|
693
|
+
<span class="default">
|
694
|
+
|
695
|
+
</span>
|
696
|
+
|
697
|
+
— <div class='inline'><p>
|
698
|
+
Filter results
|
699
|
+
</p>
|
604
700
|
</div>
|
605
701
|
|
606
702
|
</li>
|
@@ -610,6 +706,25 @@
|
|
610
706
|
|
611
707
|
|
612
708
|
|
709
|
+
<p class="tag_title">Returns:</p>
|
710
|
+
<ul class="return">
|
711
|
+
|
712
|
+
<li>
|
713
|
+
|
714
|
+
|
715
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
—
|
720
|
+
<div class='inline'><p>
|
721
|
+
First item: parsed data; second item: raw body
|
722
|
+
</p>
|
723
|
+
</div>
|
724
|
+
|
725
|
+
</li>
|
726
|
+
|
727
|
+
</ul>
|
613
728
|
|
614
729
|
</div><table class="source_code">
|
615
730
|
<tr>
|
@@ -617,20 +732,17 @@
|
|
617
732
|
<pre class="lines">
|
618
733
|
|
619
734
|
|
620
|
-
13
|
621
|
-
14
|
622
|
-
15
|
623
735
|
16
|
624
|
-
17
|
736
|
+
17
|
737
|
+
18</pre>
|
625
738
|
</td>
|
626
739
|
<td>
|
627
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line
|
740
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line 16</span>
|
628
741
|
|
629
|
-
<span class='kw'>def</span> <span class='
|
630
|
-
<span class='
|
631
|
-
|
632
|
-
|
633
|
-
<span class='kw'>end</span></pre>
|
742
|
+
<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>
|
743
|
+
<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>
|
744
|
+
<span class='rubyid_end end kw'>end</span>
|
745
|
+
</pre>
|
634
746
|
</td>
|
635
747
|
</tr>
|
636
748
|
</table>
|
@@ -639,7 +751,7 @@
|
|
639
751
|
<div class="method_details ">
|
640
752
|
<h3 class="signature " id="show-instance_method">
|
641
753
|
|
642
|
-
- (<tt>
|
754
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
643
755
|
|
644
756
|
|
645
757
|
|
@@ -647,7 +759,10 @@
|
|
647
759
|
|
648
760
|
</h3><div class="docstring">
|
649
761
|
<div class="discussion">
|
650
|
-
|
762
|
+
<p>
|
763
|
+
First item: parsed data; second item: raw body
|
764
|
+
</p>
|
765
|
+
|
651
766
|
|
652
767
|
</div>
|
653
768
|
</div>
|
@@ -663,12 +778,13 @@
|
|
663
778
|
<span class='type'>(<tt>Hash</tt>)</span>
|
664
779
|
|
665
780
|
|
666
|
-
<em class="default">(defaults to: <tt>{
|
781
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
667
782
|
|
668
783
|
|
669
784
|
—
|
670
|
-
<div class='inline'>
|
671
|
-
|
785
|
+
<div class='inline'><p>
|
786
|
+
a hash of params to be passed to the service
|
787
|
+
</p>
|
672
788
|
</div>
|
673
789
|
|
674
790
|
</li>
|
@@ -681,12 +797,13 @@
|
|
681
797
|
<span class='type'>(<tt>Hash</tt>)</span>
|
682
798
|
|
683
799
|
|
684
|
-
<em class="default">(defaults to: <tt>{
|
800
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
685
801
|
|
686
802
|
|
687
803
|
—
|
688
|
-
<div class='inline'>
|
689
|
-
|
804
|
+
<div class='inline'><p>
|
805
|
+
additional http headers
|
806
|
+
</p>
|
690
807
|
</div>
|
691
808
|
|
692
809
|
</li>
|
@@ -713,6 +830,25 @@
|
|
713
830
|
|
714
831
|
|
715
832
|
|
833
|
+
<p class="tag_title">Returns:</p>
|
834
|
+
<ul class="return">
|
835
|
+
|
836
|
+
<li>
|
837
|
+
|
838
|
+
|
839
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
840
|
+
|
841
|
+
|
842
|
+
|
843
|
+
—
|
844
|
+
<div class='inline'><p>
|
845
|
+
First item: parsed data; second item: raw body
|
846
|
+
</p>
|
847
|
+
</div>
|
848
|
+
|
849
|
+
</li>
|
850
|
+
|
851
|
+
</ul>
|
716
852
|
|
717
853
|
</div><table class="source_code">
|
718
854
|
<tr>
|
@@ -720,20 +856,17 @@
|
|
720
856
|
<pre class="lines">
|
721
857
|
|
722
858
|
|
723
|
-
23
|
724
|
-
24
|
725
859
|
25
|
726
860
|
26
|
727
861
|
27</pre>
|
728
862
|
</td>
|
729
863
|
<td>
|
730
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line
|
864
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line 25</span>
|
731
865
|
|
732
|
-
<span class='kw'>def</span> <span class='
|
733
|
-
<span class='
|
734
|
-
|
735
|
-
|
736
|
-
<span class='kw'>end</span></pre>
|
866
|
+
<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>
|
867
|
+
<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>
|
868
|
+
<span class='rubyid_end end kw'>end</span>
|
869
|
+
</pre>
|
737
870
|
</td>
|
738
871
|
</tr>
|
739
872
|
</table>
|
@@ -742,7 +875,7 @@
|
|
742
875
|
<div class="method_details ">
|
743
876
|
<h3 class="signature " id="update-instance_method">
|
744
877
|
|
745
|
-
- (<tt>
|
878
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
746
879
|
|
747
880
|
|
748
881
|
|
@@ -750,7 +883,10 @@
|
|
750
883
|
|
751
884
|
</h3><div class="docstring">
|
752
885
|
<div class="discussion">
|
753
|
-
|
886
|
+
<p>
|
887
|
+
First item: parsed data; second item: raw body
|
888
|
+
</p>
|
889
|
+
|
754
890
|
|
755
891
|
</div>
|
756
892
|
</div>
|
@@ -766,12 +902,13 @@
|
|
766
902
|
<span class='type'>(<tt>Hash</tt>)</span>
|
767
903
|
|
768
904
|
|
769
|
-
<em class="default">(defaults to: <tt>{
|
905
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
770
906
|
|
771
907
|
|
772
908
|
—
|
773
|
-
<div class='inline'>
|
774
|
-
|
909
|
+
<div class='inline'><p>
|
910
|
+
a hash of params to be passed to the service
|
911
|
+
</p>
|
775
912
|
</div>
|
776
913
|
|
777
914
|
</li>
|
@@ -784,12 +921,13 @@
|
|
784
921
|
<span class='type'>(<tt>Hash</tt>)</span>
|
785
922
|
|
786
923
|
|
787
|
-
<em class="default">(defaults to: <tt>{
|
924
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
788
925
|
|
789
926
|
|
790
927
|
—
|
791
|
-
<div class='inline'>
|
792
|
-
|
928
|
+
<div class='inline'><p>
|
929
|
+
additional http headers
|
930
|
+
</p>
|
793
931
|
</div>
|
794
932
|
|
795
933
|
</li>
|
@@ -818,11 +956,14 @@
|
|
818
956
|
|
819
957
|
</span>
|
820
958
|
|
821
|
-
— <div class='inline'>
|
822
|
-
|
823
|
-
|
824
|
-
<
|
825
|
-
|
959
|
+
— <div class='inline'><p>
|
960
|
+
allowed keys are:
|
961
|
+
</p>
|
962
|
+
<ul>
|
963
|
+
<li>name [String]
|
964
|
+
|
965
|
+
</li>
|
966
|
+
</ul>
|
826
967
|
</div>
|
827
968
|
|
828
969
|
</li>
|
@@ -832,6 +973,25 @@
|
|
832
973
|
|
833
974
|
|
834
975
|
|
976
|
+
<p class="tag_title">Returns:</p>
|
977
|
+
<ul class="return">
|
978
|
+
|
979
|
+
<li>
|
980
|
+
|
981
|
+
|
982
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
983
|
+
|
984
|
+
|
985
|
+
|
986
|
+
—
|
987
|
+
<div class='inline'><p>
|
988
|
+
First item: parsed data; second item: raw body
|
989
|
+
</p>
|
990
|
+
</div>
|
991
|
+
|
992
|
+
</li>
|
993
|
+
|
994
|
+
</ul>
|
835
995
|
|
836
996
|
</div><table class="source_code">
|
837
997
|
<tr>
|
@@ -841,18 +1001,15 @@
|
|
841
1001
|
|
842
1002
|
48
|
843
1003
|
49
|
844
|
-
50
|
845
|
-
51
|
846
|
-
52</pre>
|
1004
|
+
50</pre>
|
847
1005
|
</td>
|
848
1006
|
<td>
|
849
1007
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/usergroup.rb', line 48</span>
|
850
1008
|
|
851
|
-
<span class='kw'>def</span> <span class='
|
852
|
-
<span class='
|
853
|
-
|
854
|
-
|
855
|
-
<span class='kw'>end</span></pre>
|
1009
|
+
<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>
|
1010
|
+
<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>
|
1011
|
+
<span class='rubyid_end end kw'>end</span>
|
1012
|
+
</pre>
|
856
1013
|
</td>
|
857
1014
|
</tr>
|
858
1015
|
</table>
|
@@ -863,9 +1020,9 @@
|
|
863
1020
|
</div>
|
864
1021
|
|
865
1022
|
<div id="footer">
|
866
|
-
Generated on
|
1023
|
+
Generated on Tue Mar 19 09:50:25 2013 by
|
867
1024
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
868
|
-
0.8.
|
1025
|
+
0.8.5.2 (ruby-1.8.7).
|
869
1026
|
</div>
|
870
1027
|
|
871
1028
|
</body>
|