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.
Files changed (85) hide show
  1. data/.gitignore +3 -0
  2. data/Gemfile +2 -0
  3. data/Rakefile +0 -1
  4. data/doc/ForemanApi.html +5 -5
  5. data/doc/ForemanApi/Resources.html +6 -6
  6. data/doc/ForemanApi/Resources/Architecture.html +260 -127
  7. data/doc/ForemanApi/Resources/Audit.html +118 -51
  8. data/doc/ForemanApi/Resources/AuthSourceLdap.html +314 -163
  9. data/doc/ForemanApi/Resources/Bookmark.html +266 -131
  10. data/doc/ForemanApi/Resources/CommonParameter.html +260 -127
  11. data/doc/ForemanApi/Resources/ComputeResource.html +314 -165
  12. data/doc/ForemanApi/Resources/ConfigTemplate.html +387 -195
  13. data/doc/ForemanApi/Resources/Dashboard.html +53 -27
  14. data/doc/ForemanApi/Resources/Domain.html +275 -137
  15. data/doc/ForemanApi/Resources/Environment.html +254 -123
  16. data/doc/ForemanApi/Resources/FactValue.html +75 -32
  17. data/doc/ForemanApi/Resources/Home.html +92 -43
  18. data/doc/ForemanApi/Resources/Host.html +401 -212
  19. data/doc/ForemanApi/Resources/HostClass.html +698 -0
  20. data/doc/ForemanApi/Resources/Hostgroup.html +308 -159
  21. data/doc/ForemanApi/Resources/HostgroupClass.html +712 -0
  22. data/doc/ForemanApi/Resources/Image.html +284 -143
  23. data/doc/ForemanApi/Resources/LookupKey.html +295 -140
  24. data/doc/ForemanApi/Resources/Medium.html +278 -145
  25. data/doc/ForemanApi/Resources/Model.html +272 -135
  26. data/doc/ForemanApi/Resources/OperatingSystem.html +323 -160
  27. data/doc/ForemanApi/Resources/Parameter.html +1512 -0
  28. data/doc/ForemanApi/Resources/Ptable.html +266 -131
  29. data/doc/ForemanApi/Resources/Puppetclass.html +295 -131
  30. data/doc/ForemanApi/Resources/Report.html +311 -71
  31. data/doc/ForemanApi/Resources/Role.html +248 -119
  32. data/doc/ForemanApi/Resources/Setting.html +156 -76
  33. data/doc/ForemanApi/Resources/SmartProxy.html +257 -125
  34. data/doc/ForemanApi/Resources/Subnet.html +332 -175
  35. data/doc/ForemanApi/Resources/TemplateCombination.html +826 -0
  36. data/doc/ForemanApi/Resources/TemplateKind.html +56 -29
  37. data/doc/ForemanApi/Resources/User.html +287 -145
  38. data/doc/ForemanApi/Resources/Usergroup.html +272 -115
  39. data/doc/_index.html +32 -4
  40. data/doc/class_list.html +1 -1
  41. data/doc/css/style.css +10 -0
  42. data/doc/file.MIT-LICENSE.html +29 -24
  43. data/doc/file.README.html +60 -59
  44. data/doc/frames.html +1 -1
  45. data/doc/index.html +60 -59
  46. data/doc/method_list.html +434 -266
  47. data/doc/top-level-namespace.html +3 -3
  48. data/lib/foreman_api.rb +0 -13
  49. data/lib/foreman_api/base.rb +77 -7
  50. data/lib/foreman_api/documentation.json +1 -1
  51. data/lib/foreman_api/resources/architecture.rb +27 -32
  52. data/lib/foreman_api/resources/audit.rb +9 -10
  53. data/lib/foreman_api/resources/auth_source_ldap.rb +47 -52
  54. data/lib/foreman_api/resources/bookmark.rb +31 -36
  55. data/lib/foreman_api/resources/common_parameter.rb +27 -32
  56. data/lib/foreman_api/resources/compute_resource.rb +43 -48
  57. data/lib/foreman_api/resources/config_template.rb +43 -50
  58. data/lib/foreman_api/resources/dashboard.rb +4 -5
  59. data/lib/foreman_api/resources/domain.rb +30 -35
  60. data/lib/foreman_api/resources/environment.rb +25 -30
  61. data/lib/foreman_api/resources/fact_value.rb +5 -5
  62. data/lib/foreman_api/resources/home.rb +7 -9
  63. data/lib/foreman_api/resources/host.rb +63 -69
  64. data/lib/foreman_api/resources/host_class.rb +39 -0
  65. data/lib/foreman_api/resources/hostgroup.rb +43 -48
  66. data/lib/foreman_api/resources/hostgroup_class.rb +40 -0
  67. data/lib/foreman_api/resources/image.rb +40 -45
  68. data/lib/foreman_api/resources/lookup_key.rb +36 -40
  69. data/lib/foreman_api/resources/medium.rb +29 -34
  70. data/lib/foreman_api/resources/model.rb +31 -36
  71. data/lib/foreman_api/resources/operating_system.rb +39 -45
  72. data/lib/foreman_api/resources/parameter.rb +96 -0
  73. data/lib/foreman_api/resources/ptable.rb +29 -34
  74. data/lib/foreman_api/resources/puppetclass.rb +31 -34
  75. data/lib/foreman_api/resources/report.rb +17 -20
  76. data/lib/foreman_api/resources/role.rb +25 -30
  77. data/lib/foreman_api/resources/setting.rb +15 -18
  78. data/lib/foreman_api/resources/smart_proxy.rb +27 -32
  79. data/lib/foreman_api/resources/subnet.rb +47 -52
  80. data/lib/foreman_api/resources/template_combination.rb +21 -25
  81. data/lib/foreman_api/resources/template_kind.rb +4 -5
  82. data/lib/foreman_api/resources/user.rb +36 -41
  83. data/lib/foreman_api/resources/usergroup.rb +25 -30
  84. data/lib/foreman_api/version.rb +1 -1
  85. metadata +10 -2
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: ForemanApi::Resources::CommonParameter
8
8
 
9
- &mdash; Documentation by YARD 0.8.3
9
+ &mdash; 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)">- (Object) <strong>create</strong>(params = { }, headers = { }) </a>
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'></div></span>
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)">- (Object) <strong>destroy</strong>(params = { }, headers = { }) </a>
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'></div></span>
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)">- (Object) <strong>index</strong>(params = { }, headers = { }) </a>
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'></div></span>
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)">- (Object) <strong>show</strong>(params = { }, headers = { }) </a>
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'></div></span>
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)">- (Object) <strong>update</strong>(params = { }, headers = { }) </a>
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'></div></span>
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/common_parameter.rb', line 4</span>
291
306
 
292
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
293
- <span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>common_parameters</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
294
- <span class='kw'>end</span></pre>
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'>&quot;common_parameters&quot;</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>Object</tt>) <strong>create</strong>(params = { }, headers = { })
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>{ }</tt>)</em>
352
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
334
353
 
335
354
 
336
355
  &mdash;
337
- <div class='inline'>
338
- <p>a hash of params to be passed to the service</p>
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>{ }</tt>)</em>
371
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
352
372
 
353
373
 
354
374
  &mdash;
355
- <div class='inline'>
356
- <p>additional http headers</p>
375
+ <div class='inline'><p>
376
+ additional http headers
377
+ </p>
357
378
  </div>
358
379
 
359
380
  </li>
@@ -373,13 +394,17 @@
373
394
 
374
395
  </span>
375
396
 
376
- &mdash; <div class='inline'>
377
- <p>allowed keys are:</p>
378
- <ul><li>
379
- <p>name [String],</p>
380
- </li><li>
381
- <p>value [String],</p>
382
- </li></ul>
397
+ &mdash; <div class='inline'><p>
398
+ allowed keys are:
399
+ </p>
400
+ <ul>
401
+ <li>name [String]
402
+
403
+ </li>
404
+ <li>value [String]
405
+
406
+ </li>
407
+ </ul>
383
408
  </div>
384
409
 
385
410
  </li>
@@ -389,6 +414,25 @@
389
414
 
390
415
 
391
416
 
417
+ <p class="tag_title">Returns:</p>
418
+ <ul class="return">
419
+
420
+ <li>
421
+
422
+
423
+ <span class='type'>(<tt>Array</tt>)</span>
424
+
425
+
426
+
427
+ &mdash;
428
+ <div class='inline'><p>
429
+ First item: parsed data; second item: raw body
430
+ </p>
431
+ </div>
432
+
433
+ </li>
434
+
435
+ </ul>
392
436
 
393
437
  </div><table class="source_code">
394
438
  <tr>
@@ -396,20 +440,17 @@
396
440
  <pre class="lines">
397
441
 
398
442
 
443
+ 37
399
444
  38
400
- 39
401
- 40
402
- 41
403
- 42</pre>
445
+ 39</pre>
404
446
  </td>
405
447
  <td>
406
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 38</span>
448
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 37</span>
407
449
 
408
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
409
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
410
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/common_parameters</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
411
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
412
- <span class='kw'>end</span></pre>
450
+ <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>
451
+ <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>
452
+ <span class='rubyid_end end kw'>end</span>
453
+ </pre>
413
454
  </td>
414
455
  </tr>
415
456
  </table>
@@ -418,7 +459,7 @@
418
459
  <div class="method_details ">
419
460
  <h3 class="signature " id="destroy-instance_method">
420
461
 
421
- - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
462
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
422
463
 
423
464
 
424
465
 
@@ -426,7 +467,10 @@
426
467
 
427
468
  </h3><div class="docstring">
428
469
  <div class="discussion">
429
-
470
+ <p>
471
+ First item: parsed data; second item: raw body
472
+ </p>
473
+
430
474
 
431
475
  </div>
432
476
  </div>
@@ -442,12 +486,13 @@
442
486
  <span class='type'>(<tt>Hash</tt>)</span>
443
487
 
444
488
 
445
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
489
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
446
490
 
447
491
 
448
492
  &mdash;
449
- <div class='inline'>
450
- <p>a hash of params to be passed to the service</p>
493
+ <div class='inline'><p>
494
+ a hash of params to be passed to the service
495
+ </p>
451
496
  </div>
452
497
 
453
498
  </li>
@@ -460,12 +505,13 @@
460
505
  <span class='type'>(<tt>Hash</tt>)</span>
461
506
 
462
507
 
463
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
508
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
464
509
 
465
510
 
466
511
  &mdash;
467
- <div class='inline'>
468
- <p>additional http headers</p>
512
+ <div class='inline'><p>
513
+ additional http headers
514
+ </p>
469
515
  </div>
470
516
 
471
517
  </li>
@@ -492,6 +538,25 @@
492
538
 
493
539
 
494
540
 
541
+ <p class="tag_title">Returns:</p>
542
+ <ul class="return">
543
+
544
+ <li>
545
+
546
+
547
+ <span class='type'>(<tt>Array</tt>)</span>
548
+
549
+
550
+
551
+ &mdash;
552
+ <div class='inline'><p>
553
+ First item: parsed data; second item: raw body
554
+ </p>
555
+ </div>
556
+
557
+ </li>
558
+
559
+ </ul>
495
560
 
496
561
  </div><table class="source_code">
497
562
  <tr>
@@ -499,20 +564,17 @@
499
564
  <pre class="lines">
500
565
 
501
566
 
502
- 62
503
- 63
504
- 64
505
- 65
506
- 66</pre>
567
+ 59
568
+ 60
569
+ 61</pre>
507
570
  </td>
508
571
  <td>
509
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 62</span>
572
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 59</span>
510
573
 
511
- <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
512
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
513
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/common_parameters/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
514
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
515
- <span class='kw'>end</span></pre>
574
+ <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>
575
+ <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>
576
+ <span class='rubyid_end end kw'>end</span>
577
+ </pre>
516
578
  </td>
517
579
  </tr>
518
580
  </table>
@@ -521,7 +583,7 @@
521
583
  <div class="method_details ">
522
584
  <h3 class="signature " id="index-instance_method">
523
585
 
524
- - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
586
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
525
587
 
526
588
 
527
589
 
@@ -529,7 +591,10 @@
529
591
 
530
592
  </h3><div class="docstring">
531
593
  <div class="discussion">
532
-
594
+ <p>
595
+ First item: parsed data; second item: raw body
596
+ </p>
597
+
533
598
 
534
599
  </div>
535
600
  </div>
@@ -545,12 +610,13 @@
545
610
  <span class='type'>(<tt>Hash</tt>)</span>
546
611
 
547
612
 
548
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
613
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
549
614
 
550
615
 
551
616
  &mdash;
552
- <div class='inline'>
553
- <p>a hash of params to be passed to the service</p>
617
+ <div class='inline'><p>
618
+ a hash of params to be passed to the service
619
+ </p>
554
620
  </div>
555
621
 
556
622
  </li>
@@ -563,12 +629,13 @@
563
629
  <span class='type'>(<tt>Hash</tt>)</span>
564
630
 
565
631
 
566
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
632
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
567
633
 
568
634
 
569
635
  &mdash;
570
- <div class='inline'>
571
- <p>additional http headers</p>
636
+ <div class='inline'><p>
637
+ additional http headers
638
+ </p>
572
639
  </div>
573
640
 
574
641
  </li>
@@ -588,8 +655,9 @@
588
655
 
589
656
  </span>
590
657
 
591
- &mdash; <div class='inline'>
592
- <p>Sort results</p>
658
+ &mdash; <div class='inline'><p>
659
+ Sort results
660
+ </p>
593
661
  </div>
594
662
 
595
663
  </li>
@@ -601,8 +669,9 @@
601
669
 
602
670
  </span>
603
671
 
604
- &mdash; <div class='inline'>
605
- <p>Paginate results</p>
672
+ &mdash; <div class='inline'><p>
673
+ Paginate results
674
+ </p>
606
675
  </div>
607
676
 
608
677
  </li>
@@ -614,8 +683,9 @@
614
683
 
615
684
  </span>
616
685
 
617
- &mdash; <div class='inline'>
618
- <p>Number of entries per request</p>
686
+ &mdash; <div class='inline'><p>
687
+ Number of entries per request
688
+ </p>
619
689
  </div>
620
690
 
621
691
  </li>
@@ -627,8 +697,9 @@
627
697
 
628
698
  </span>
629
699
 
630
- &mdash; <div class='inline'>
631
- <p>Filter results</p>
700
+ &mdash; <div class='inline'><p>
701
+ Filter results
702
+ </p>
632
703
  </div>
633
704
 
634
705
  </li>
@@ -638,6 +709,25 @@
638
709
 
639
710
 
640
711
 
712
+ <p class="tag_title">Returns:</p>
713
+ <ul class="return">
714
+
715
+ <li>
716
+
717
+
718
+ <span class='type'>(<tt>Array</tt>)</span>
719
+
720
+
721
+
722
+ &mdash;
723
+ <div class='inline'><p>
724
+ First item: parsed data; second item: raw body
725
+ </p>
726
+ </div>
727
+
728
+ </li>
729
+
730
+ </ul>
641
731
 
642
732
  </div><table class="source_code">
643
733
  <tr>
@@ -645,20 +735,17 @@
645
735
  <pre class="lines">
646
736
 
647
737
 
648
- 15
649
738
  16
650
739
  17
651
- 18
652
- 19</pre>
740
+ 18</pre>
653
741
  </td>
654
742
  <td>
655
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 15</span>
743
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 16</span>
656
744
 
657
- <span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
658
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
659
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/common_parameters</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
660
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
661
- <span class='kw'>end</span></pre>
745
+ <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>
746
+ <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>
747
+ <span class='rubyid_end end kw'>end</span>
748
+ </pre>
662
749
  </td>
663
750
  </tr>
664
751
  </table>
@@ -667,7 +754,7 @@
667
754
  <div class="method_details ">
668
755
  <h3 class="signature " id="show-instance_method">
669
756
 
670
- - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
757
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
671
758
 
672
759
 
673
760
 
@@ -675,7 +762,10 @@
675
762
 
676
763
  </h3><div class="docstring">
677
764
  <div class="discussion">
678
-
765
+ <p>
766
+ First item: parsed data; second item: raw body
767
+ </p>
768
+
679
769
 
680
770
  </div>
681
771
  </div>
@@ -691,12 +781,13 @@
691
781
  <span class='type'>(<tt>Hash</tt>)</span>
692
782
 
693
783
 
694
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
784
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
695
785
 
696
786
 
697
787
  &mdash;
698
- <div class='inline'>
699
- <p>a hash of params to be passed to the service</p>
788
+ <div class='inline'><p>
789
+ a hash of params to be passed to the service
790
+ </p>
700
791
  </div>
701
792
 
702
793
  </li>
@@ -709,12 +800,13 @@
709
800
  <span class='type'>(<tt>Hash</tt>)</span>
710
801
 
711
802
 
712
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
803
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
713
804
 
714
805
 
715
806
  &mdash;
716
- <div class='inline'>
717
- <p>additional http headers</p>
807
+ <div class='inline'><p>
808
+ additional http headers
809
+ </p>
718
810
  </div>
719
811
 
720
812
  </li>
@@ -741,6 +833,25 @@
741
833
 
742
834
 
743
835
 
836
+ <p class="tag_title">Returns:</p>
837
+ <ul class="return">
838
+
839
+ <li>
840
+
841
+
842
+ <span class='type'>(<tt>Array</tt>)</span>
843
+
844
+
845
+
846
+ &mdash;
847
+ <div class='inline'><p>
848
+ First item: parsed data; second item: raw body
849
+ </p>
850
+ </div>
851
+
852
+ </li>
853
+
854
+ </ul>
744
855
 
745
856
  </div><table class="source_code">
746
857
  <tr>
@@ -750,18 +861,15 @@
750
861
 
751
862
  25
752
863
  26
753
- 27
754
- 28
755
- 29</pre>
864
+ 27</pre>
756
865
  </td>
757
866
  <td>
758
867
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 25</span>
759
868
 
760
- <span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
761
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
762
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/common_parameters/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
763
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
764
- <span class='kw'>end</span></pre>
869
+ <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>
870
+ <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>
871
+ <span class='rubyid_end end kw'>end</span>
872
+ </pre>
765
873
  </td>
766
874
  </tr>
767
875
  </table>
@@ -770,7 +878,7 @@
770
878
  <div class="method_details ">
771
879
  <h3 class="signature " id="update-instance_method">
772
880
 
773
- - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
881
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
774
882
 
775
883
 
776
884
 
@@ -778,7 +886,10 @@
778
886
 
779
887
  </h3><div class="docstring">
780
888
  <div class="discussion">
781
-
889
+ <p>
890
+ First item: parsed data; second item: raw body
891
+ </p>
892
+
782
893
 
783
894
  </div>
784
895
  </div>
@@ -794,12 +905,13 @@
794
905
  <span class='type'>(<tt>Hash</tt>)</span>
795
906
 
796
907
 
797
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
908
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
798
909
 
799
910
 
800
911
  &mdash;
801
- <div class='inline'>
802
- <p>a hash of params to be passed to the service</p>
912
+ <div class='inline'><p>
913
+ a hash of params to be passed to the service
914
+ </p>
803
915
  </div>
804
916
 
805
917
  </li>
@@ -812,12 +924,13 @@
812
924
  <span class='type'>(<tt>Hash</tt>)</span>
813
925
 
814
926
 
815
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
927
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
816
928
 
817
929
 
818
930
  &mdash;
819
- <div class='inline'>
820
- <p>additional http headers</p>
931
+ <div class='inline'><p>
932
+ additional http headers
933
+ </p>
821
934
  </div>
822
935
 
823
936
  </li>
@@ -846,13 +959,17 @@
846
959
 
847
960
  </span>
848
961
 
849
- &mdash; <div class='inline'>
850
- <p>allowed keys are:</p>
851
- <ul><li>
852
- <p>name [String],</p>
853
- </li><li>
854
- <p>value [String],</p>
855
- </li></ul>
962
+ &mdash; <div class='inline'><p>
963
+ allowed keys are:
964
+ </p>
965
+ <ul>
966
+ <li>name [String]
967
+
968
+ </li>
969
+ <li>value [String]
970
+
971
+ </li>
972
+ </ul>
856
973
  </div>
857
974
 
858
975
  </li>
@@ -862,6 +979,25 @@
862
979
 
863
980
 
864
981
 
982
+ <p class="tag_title">Returns:</p>
983
+ <ul class="return">
984
+
985
+ <li>
986
+
987
+
988
+ <span class='type'>(<tt>Array</tt>)</span>
989
+
990
+
991
+
992
+ &mdash;
993
+ <div class='inline'><p>
994
+ First item: parsed data; second item: raw body
995
+ </p>
996
+ </div>
997
+
998
+ </li>
999
+
1000
+ </ul>
865
1001
 
866
1002
  </div><table class="source_code">
867
1003
  <tr>
@@ -869,20 +1005,17 @@
869
1005
  <pre class="lines">
870
1006
 
871
1007
 
872
- 52
873
- 53
874
- 54
875
- 55
876
- 56</pre>
1008
+ 50
1009
+ 51
1010
+ 52</pre>
877
1011
  </td>
878
1012
  <td>
879
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 52</span>
1013
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 50</span>
880
1014
 
881
- <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
882
- <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
883
- <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/common_parameters/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
884
- <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
885
- <span class='kw'>end</span></pre>
1015
+ <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>
1016
+ <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>
1017
+ <span class='rubyid_end end kw'>end</span>
1018
+ </pre>
886
1019
  </td>
887
1020
  </tr>
888
1021
  </table>
@@ -893,9 +1026,9 @@
893
1026
  </div>
894
1027
 
895
1028
  <div id="footer">
896
- Generated on Mon Jan 21 15:44:37 2013 by
1029
+ Generated on Tue Mar 19 09:50:27 2013 by
897
1030
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
898
- 0.8.3 (ruby-1.9.3).
1031
+ 0.8.5.2 (ruby-1.8.7).
899
1032
  </div>
900
1033
 
901
1034
  </body>