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.
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::Image
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/image.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'>images</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;images&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>
@@ -382,21 +403,29 @@
382
403
 
383
404
  </span>
384
405
 
385
- &mdash; <div class='inline'>
386
- <p>allowed keys are:</p>
387
- <ul><li>
388
- <p>architecture_id [String],</p>
389
- </li><li>
390
- <p>compute_resource_id [String],</p>
391
- </li><li>
392
- <p>name [String],</p>
393
- </li><li>
394
- <p>operatingsystem_id [String],</p>
395
- </li><li>
396
- <p>username [String],</p>
397
- </li><li>
398
- <p>uuid [String],</p>
399
- </li></ul>
406
+ &mdash; <div class='inline'><p>
407
+ allowed keys are:
408
+ </p>
409
+ <ul>
410
+ <li>architecture_id [String]
411
+
412
+ </li>
413
+ <li>compute_resource_id [String]
414
+
415
+ </li>
416
+ <li>operatingsystem_id [String]
417
+
418
+ </li>
419
+ <li>name [String]
420
+
421
+ </li>
422
+ <li>username [String]
423
+
424
+ </li>
425
+ <li>uuid [String]
426
+
427
+ </li>
428
+ </ul>
400
429
  </div>
401
430
 
402
431
  </li>
@@ -406,6 +435,25 @@
406
435
 
407
436
 
408
437
 
438
+ <p class="tag_title">Returns:</p>
439
+ <ul class="return">
440
+
441
+ <li>
442
+
443
+
444
+ <span class='type'>(<tt>Array</tt>)</span>
445
+
446
+
447
+
448
+ &mdash;
449
+ <div class='inline'><p>
450
+ First item: parsed data; second item: raw body
451
+ </p>
452
+ </div>
453
+
454
+ </li>
455
+
456
+ </ul>
409
457
 
410
458
  </div><table class="source_code">
411
459
  <tr>
@@ -413,20 +461,17 @@
413
461
  <pre class="lines">
414
462
 
415
463
 
464
+ 44
416
465
  45
417
- 46
418
- 47
419
- 48
420
- 49</pre>
466
+ 46</pre>
421
467
  </td>
422
468
  <td>
423
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 45</span>
469
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 44</span>
424
470
 
425
- <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>
426
- <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>
427
- <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/compute_resources/:compute_resource_id/images</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
428
- <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>
429
- <span class='kw'>end</span></pre>
471
+ <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>
472
+ <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>
473
+ <span class='rubyid_end end kw'>end</span>
474
+ </pre>
430
475
  </td>
431
476
  </tr>
432
477
  </table>
@@ -435,7 +480,7 @@
435
480
  <div class="method_details ">
436
481
  <h3 class="signature " id="destroy-instance_method">
437
482
 
438
- - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
483
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
439
484
 
440
485
 
441
486
 
@@ -443,7 +488,10 @@
443
488
 
444
489
  </h3><div class="docstring">
445
490
  <div class="discussion">
446
-
491
+ <p>
492
+ First item: parsed data; second item: raw body
493
+ </p>
494
+
447
495
 
448
496
  </div>
449
497
  </div>
@@ -459,12 +507,13 @@
459
507
  <span class='type'>(<tt>Hash</tt>)</span>
460
508
 
461
509
 
462
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
510
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
463
511
 
464
512
 
465
513
  &mdash;
466
- <div class='inline'>
467
- <p>a hash of params to be passed to the service</p>
514
+ <div class='inline'><p>
515
+ a hash of params to be passed to the service
516
+ </p>
468
517
  </div>
469
518
 
470
519
  </li>
@@ -477,12 +526,13 @@
477
526
  <span class='type'>(<tt>Hash</tt>)</span>
478
527
 
479
528
 
480
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
529
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
481
530
 
482
531
 
483
532
  &mdash;
484
- <div class='inline'>
485
- <p>additional http headers</p>
533
+ <div class='inline'><p>
534
+ additional http headers
535
+ </p>
486
536
  </div>
487
537
 
488
538
  </li>
@@ -518,6 +568,25 @@
518
568
 
519
569
 
520
570
 
571
+ <p class="tag_title">Returns:</p>
572
+ <ul class="return">
573
+
574
+ <li>
575
+
576
+
577
+ <span class='type'>(<tt>Array</tt>)</span>
578
+
579
+
580
+
581
+ &mdash;
582
+ <div class='inline'><p>
583
+ First item: parsed data; second item: raw body
584
+ </p>
585
+ </div>
586
+
587
+ </li>
588
+
589
+ </ul>
521
590
 
522
591
  </div><table class="source_code">
523
592
  <tr>
@@ -525,20 +594,17 @@
525
594
  <pre class="lines">
526
595
 
527
596
 
528
- 75
529
- 76
530
- 77
531
- 78
532
- 79</pre>
597
+ 72
598
+ 73
599
+ 74</pre>
533
600
  </td>
534
601
  <td>
535
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 75</span>
602
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 72</span>
536
603
 
537
- <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>
538
- <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>
539
- <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/compute_resources/:compute_resource_id/images/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
540
- <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>
541
- <span class='kw'>end</span></pre>
604
+ <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>
605
+ <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>
606
+ <span class='rubyid_end end kw'>end</span>
607
+ </pre>
542
608
  </td>
543
609
  </tr>
544
610
  </table>
@@ -547,7 +613,7 @@
547
613
  <div class="method_details ">
548
614
  <h3 class="signature " id="index-instance_method">
549
615
 
550
- - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
616
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
551
617
 
552
618
 
553
619
 
@@ -555,7 +621,10 @@
555
621
 
556
622
  </h3><div class="docstring">
557
623
  <div class="discussion">
558
-
624
+ <p>
625
+ First item: parsed data; second item: raw body
626
+ </p>
627
+
559
628
 
560
629
  </div>
561
630
  </div>
@@ -571,12 +640,13 @@
571
640
  <span class='type'>(<tt>Hash</tt>)</span>
572
641
 
573
642
 
574
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
643
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
575
644
 
576
645
 
577
646
  &mdash;
578
- <div class='inline'>
579
- <p>a hash of params to be passed to the service</p>
647
+ <div class='inline'><p>
648
+ a hash of params to be passed to the service
649
+ </p>
580
650
  </div>
581
651
 
582
652
  </li>
@@ -589,12 +659,13 @@
589
659
  <span class='type'>(<tt>Hash</tt>)</span>
590
660
 
591
661
 
592
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
662
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
593
663
 
594
664
 
595
665
  &mdash;
596
- <div class='inline'>
597
- <p>additional http headers</p>
666
+ <div class='inline'><p>
667
+ additional http headers
668
+ </p>
598
669
  </div>
599
670
 
600
671
  </li>
@@ -623,8 +694,9 @@
623
694
 
624
695
  </span>
625
696
 
626
- &mdash; <div class='inline'>
627
- <p>Sort results</p>
697
+ &mdash; <div class='inline'><p>
698
+ Sort results
699
+ </p>
628
700
  </div>
629
701
 
630
702
  </li>
@@ -636,8 +708,9 @@
636
708
 
637
709
  </span>
638
710
 
639
- &mdash; <div class='inline'>
640
- <p>Paginate results</p>
711
+ &mdash; <div class='inline'><p>
712
+ Paginate results
713
+ </p>
641
714
  </div>
642
715
 
643
716
  </li>
@@ -649,8 +722,9 @@
649
722
 
650
723
  </span>
651
724
 
652
- &mdash; <div class='inline'>
653
- <p>Number of entries per request</p>
725
+ &mdash; <div class='inline'><p>
726
+ Number of entries per request
727
+ </p>
654
728
  </div>
655
729
 
656
730
  </li>
@@ -662,8 +736,9 @@
662
736
 
663
737
  </span>
664
738
 
665
- &mdash; <div class='inline'>
666
- <p>Filter results</p>
739
+ &mdash; <div class='inline'><p>
740
+ Filter results
741
+ </p>
667
742
  </div>
668
743
 
669
744
  </li>
@@ -673,6 +748,25 @@
673
748
 
674
749
 
675
750
 
751
+ <p class="tag_title">Returns:</p>
752
+ <ul class="return">
753
+
754
+ <li>
755
+
756
+
757
+ <span class='type'>(<tt>Array</tt>)</span>
758
+
759
+
760
+
761
+ &mdash;
762
+ <div class='inline'><p>
763
+ First item: parsed data; second item: raw body
764
+ </p>
765
+ </div>
766
+
767
+ </li>
768
+
769
+ </ul>
676
770
 
677
771
  </div><table class="source_code">
678
772
  <tr>
@@ -680,20 +774,17 @@
680
774
  <pre class="lines">
681
775
 
682
776
 
683
- 16
684
777
  17
685
778
  18
686
- 19
687
- 20</pre>
779
+ 19</pre>
688
780
  </td>
689
781
  <td>
690
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 16</span>
782
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 17</span>
691
783
 
692
- <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>
693
- <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>
694
- <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/compute_resources/:compute_resource_id/images</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
695
- <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>
696
- <span class='kw'>end</span></pre>
784
+ <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>
785
+ <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>
786
+ <span class='rubyid_end end kw'>end</span>
787
+ </pre>
697
788
  </td>
698
789
  </tr>
699
790
  </table>
@@ -702,7 +793,7 @@
702
793
  <div class="method_details ">
703
794
  <h3 class="signature " id="show-instance_method">
704
795
 
705
- - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
796
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
706
797
 
707
798
 
708
799
 
@@ -710,7 +801,10 @@
710
801
 
711
802
  </h3><div class="docstring">
712
803
  <div class="discussion">
713
-
804
+ <p>
805
+ First item: parsed data; second item: raw body
806
+ </p>
807
+
714
808
 
715
809
  </div>
716
810
  </div>
@@ -726,12 +820,13 @@
726
820
  <span class='type'>(<tt>Hash</tt>)</span>
727
821
 
728
822
 
729
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
823
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
730
824
 
731
825
 
732
826
  &mdash;
733
- <div class='inline'>
734
- <p>a hash of params to be passed to the service</p>
827
+ <div class='inline'><p>
828
+ a hash of params to be passed to the service
829
+ </p>
735
830
  </div>
736
831
 
737
832
  </li>
@@ -744,12 +839,13 @@
744
839
  <span class='type'>(<tt>Hash</tt>)</span>
745
840
 
746
841
 
747
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
842
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
748
843
 
749
844
 
750
845
  &mdash;
751
- <div class='inline'>
752
- <p>additional http headers</p>
846
+ <div class='inline'><p>
847
+ additional http headers
848
+ </p>
753
849
  </div>
754
850
 
755
851
  </li>
@@ -785,6 +881,25 @@
785
881
 
786
882
 
787
883
 
884
+ <p class="tag_title">Returns:</p>
885
+ <ul class="return">
886
+
887
+ <li>
888
+
889
+
890
+ <span class='type'>(<tt>Array</tt>)</span>
891
+
892
+
893
+
894
+ &mdash;
895
+ <div class='inline'><p>
896
+ First item: parsed data; second item: raw body
897
+ </p>
898
+ </div>
899
+
900
+ </li>
901
+
902
+ </ul>
788
903
 
789
904
  </div><table class="source_code">
790
905
  <tr>
@@ -794,18 +909,15 @@
794
909
 
795
910
  27
796
911
  28
797
- 29
798
- 30
799
- 31</pre>
912
+ 29</pre>
800
913
  </td>
801
914
  <td>
802
915
  <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 27</span>
803
916
 
804
- <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>
805
- <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>
806
- <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/compute_resources/:compute_resource_id/images/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
807
- <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>
808
- <span class='kw'>end</span></pre>
917
+ <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>
918
+ <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>
919
+ <span class='rubyid_end end kw'>end</span>
920
+ </pre>
809
921
  </td>
810
922
  </tr>
811
923
  </table>
@@ -814,7 +926,7 @@
814
926
  <div class="method_details ">
815
927
  <h3 class="signature " id="update-instance_method">
816
928
 
817
- - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
929
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
818
930
 
819
931
 
820
932
 
@@ -822,7 +934,10 @@
822
934
 
823
935
  </h3><div class="docstring">
824
936
  <div class="discussion">
825
-
937
+ <p>
938
+ First item: parsed data; second item: raw body
939
+ </p>
940
+
826
941
 
827
942
  </div>
828
943
  </div>
@@ -838,12 +953,13 @@
838
953
  <span class='type'>(<tt>Hash</tt>)</span>
839
954
 
840
955
 
841
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
956
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
842
957
 
843
958
 
844
959
  &mdash;
845
- <div class='inline'>
846
- <p>a hash of params to be passed to the service</p>
960
+ <div class='inline'><p>
961
+ a hash of params to be passed to the service
962
+ </p>
847
963
  </div>
848
964
 
849
965
  </li>
@@ -856,12 +972,13 @@
856
972
  <span class='type'>(<tt>Hash</tt>)</span>
857
973
 
858
974
 
859
- <em class="default">(defaults to: <tt>{ }</tt>)</em>
975
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
860
976
 
861
977
 
862
978
  &mdash;
863
- <div class='inline'>
864
- <p>additional http headers</p>
979
+ <div class='inline'><p>
980
+ additional http headers
981
+ </p>
865
982
  </div>
866
983
 
867
984
  </li>
@@ -899,21 +1016,29 @@
899
1016
 
900
1017
  </span>
901
1018
 
902
- &mdash; <div class='inline'>
903
- <p>allowed keys are:</p>
904
- <ul><li>
905
- <p>architecture_id [String],</p>
906
- </li><li>
907
- <p>compute_resource_id [String],</p>
908
- </li><li>
909
- <p>name [String],</p>
910
- </li><li>
911
- <p>operatingsystem_id [String],</p>
912
- </li><li>
913
- <p>username [String],</p>
914
- </li><li>
915
- <p>uuid [String],</p>
916
- </li></ul>
1019
+ &mdash; <div class='inline'><p>
1020
+ allowed keys are:
1021
+ </p>
1022
+ <ul>
1023
+ <li>architecture_id [String]
1024
+
1025
+ </li>
1026
+ <li>compute_resource_id [String]
1027
+
1028
+ </li>
1029
+ <li>operatingsystem_id [String]
1030
+
1031
+ </li>
1032
+ <li>name [String]
1033
+
1034
+ </li>
1035
+ <li>username [String]
1036
+
1037
+ </li>
1038
+ <li>uuid [String]
1039
+
1040
+ </li>
1041
+ </ul>
917
1042
  </div>
918
1043
 
919
1044
  </li>
@@ -923,6 +1048,25 @@
923
1048
 
924
1049
 
925
1050
 
1051
+ <p class="tag_title">Returns:</p>
1052
+ <ul class="return">
1053
+
1054
+ <li>
1055
+
1056
+
1057
+ <span class='type'>(<tt>Array</tt>)</span>
1058
+
1059
+
1060
+
1061
+ &mdash;
1062
+ <div class='inline'><p>
1063
+ First item: parsed data; second item: raw body
1064
+ </p>
1065
+ </div>
1066
+
1067
+ </li>
1068
+
1069
+ </ul>
926
1070
 
927
1071
  </div><table class="source_code">
928
1072
  <tr>
@@ -930,20 +1074,17 @@
930
1074
  <pre class="lines">
931
1075
 
932
1076
 
933
- 64
934
- 65
935
- 66
936
- 67
937
- 68</pre>
1077
+ 62
1078
+ 63
1079
+ 64</pre>
938
1080
  </td>
939
1081
  <td>
940
- <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 64</span>
1082
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/image.rb', line 62</span>
941
1083
 
942
- <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>
943
- <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>
944
- <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/compute_resources/:compute_resource_id/images/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
945
- <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>
946
- <span class='kw'>end</span></pre>
1084
+ <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>
1085
+ <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>
1086
+ <span class='rubyid_end end kw'>end</span>
1087
+ </pre>
947
1088
  </td>
948
1089
  </tr>
949
1090
  </table>
@@ -954,9 +1095,9 @@
954
1095
  </div>
955
1096
 
956
1097
  <div id="footer">
957
- Generated on Mon Jan 21 15:44:34 2013 by
1098
+ Generated on Tue Mar 19 09:50:23 2013 by
958
1099
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
959
- 0.8.3 (ruby-1.9.3).
1100
+ 0.8.5.2 (ruby-1.8.7).
960
1101
  </div>
961
1102
 
962
1103
  </body>