foreman_api 0.0.10 → 0.0.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. data/.yardopts +4 -0
  2. data/Gemfile +5 -0
  3. data/README.rdoc +23 -4
  4. data/doc/ForemanApi/Resources/Architecture.html +902 -0
  5. data/doc/ForemanApi/Resources/Audit.html +500 -0
  6. data/doc/ForemanApi/Resources/AuthSourceLdap.html +916 -0
  7. data/doc/ForemanApi/Resources/Bookmark.html +884 -0
  8. data/doc/ForemanApi/Resources/CommonParameter.html +902 -0
  9. data/doc/ForemanApi/Resources/ComputeResource.html +940 -0
  10. data/doc/ForemanApi/Resources/ConfigTemplate.html +1160 -0
  11. data/doc/ForemanApi/Resources/Dashboard.html +336 -0
  12. data/doc/ForemanApi/Resources/Domain.html +914 -0
  13. data/doc/ForemanApi/Resources/Environment.html +898 -0
  14. data/doc/ForemanApi/Resources/FactValue.html +375 -0
  15. data/doc/ForemanApi/Resources/Home.html +417 -0
  16. data/doc/ForemanApi/Resources/Host.html +1091 -0
  17. data/doc/ForemanApi/Resources/Hostgroup.html +934 -0
  18. data/doc/ForemanApi/Resources/Image.html +963 -0
  19. data/doc/ForemanApi/Resources/LookupKey.html +918 -0
  20. data/doc/ForemanApi/Resources/Medium.html +920 -0
  21. data/doc/ForemanApi/Resources/Model.html +910 -0
  22. data/doc/ForemanApi/Resources/OperatingSystem.html +1057 -0
  23. data/doc/ForemanApi/Resources/Ptable.html +906 -0
  24. data/doc/ForemanApi/Resources/Puppetclass.html +898 -0
  25. data/doc/ForemanApi/Resources/Report.html +625 -0
  26. data/doc/ForemanApi/Resources/Role.html +872 -0
  27. data/doc/ForemanApi/Resources/Setting.html +641 -0
  28. data/doc/ForemanApi/Resources/SmartProxy.html +889 -0
  29. data/doc/ForemanApi/Resources/Subnet.html +954 -0
  30. data/doc/ForemanApi/Resources/TemplateKind.html +349 -0
  31. data/doc/ForemanApi/Resources/User.html +920 -0
  32. data/doc/ForemanApi/Resources/Usergroup.html +872 -0
  33. data/doc/ForemanApi/Resources.html +117 -0
  34. data/doc/ForemanApi.html +117 -0
  35. data/doc/_index.html +449 -0
  36. data/doc/class_list.html +53 -0
  37. data/doc/css/common.css +1 -0
  38. data/doc/css/full_list.css +57 -0
  39. data/doc/css/style.css +328 -0
  40. data/doc/file.MIT-LICENSE.html +93 -0
  41. data/doc/file.README.html +129 -0
  42. data/doc/file_list.html +58 -0
  43. data/doc/frames.html +28 -0
  44. data/doc/index.html +129 -0
  45. data/doc/js/app.js +214 -0
  46. data/doc/js/full_list.js +173 -0
  47. data/doc/js/jquery.js +4 -0
  48. data/doc/method_list.html +1300 -0
  49. data/doc/top-level-namespace.html +112 -0
  50. data/foreman_api.gemspec +5 -2
  51. data/lib/foreman_api/base.rb +129 -0
  52. data/lib/foreman_api/resources/architecture.rb +17 -7
  53. data/lib/foreman_api/resources/audit.rb +7 -4
  54. data/lib/foreman_api/resources/auth_source_ldap.rb +35 -7
  55. data/lib/foreman_api/resources/bookmark.rb +19 -7
  56. data/lib/foreman_api/resources/common_parameter.rb +17 -7
  57. data/lib/foreman_api/resources/compute_resource.rb +33 -7
  58. data/lib/foreman_api/resources/config_template.rb +28 -9
  59. data/lib/foreman_api/resources/dashboard.rb +3 -3
  60. data/lib/foreman_api/resources/domain.rb +21 -7
  61. data/lib/foreman_api/resources/environment.rb +15 -7
  62. data/lib/foreman_api/resources/fact_value.rb +6 -3
  63. data/lib/foreman_api/resources/home.rb +2 -4
  64. data/lib/foreman_api/resources/host.rb +50 -8
  65. data/lib/foreman_api/resources/hostgroup.rb +33 -7
  66. data/lib/foreman_api/resources/image.rb +30 -7
  67. data/lib/foreman_api/resources/lookup_key.rb +25 -7
  68. data/lib/foreman_api/resources/medium.rb +19 -7
  69. data/lib/foreman_api/resources/model.rb +21 -7
  70. data/lib/foreman_api/resources/operating_system.rb +26 -8
  71. data/lib/foreman_api/resources/ptable.rb +19 -7
  72. data/lib/foreman_api/resources/puppetclass.rb +15 -7
  73. data/lib/foreman_api/resources/report.rb +8 -5
  74. data/lib/foreman_api/resources/role.rb +13 -7
  75. data/lib/foreman_api/resources/setting.rb +11 -5
  76. data/lib/foreman_api/resources/smart_proxy.rb +16 -7
  77. data/lib/foreman_api/resources/subnet.rb +39 -7
  78. data/lib/foreman_api/resources/template_kind.rb +4 -3
  79. data/lib/foreman_api/resources/user.rb +26 -7
  80. data/lib/foreman_api/resources/usergroup.rb +13 -7
  81. data/lib/foreman_api/rest_client_oauth.rb +19 -0
  82. data/lib/foreman_api/version.rb +1 -1
  83. data/lib/foreman_api.rb +6 -10
  84. metadata +51 -18
data/doc/ForemanApi/Resources/OperatingSystem.html ADDED
@@ -0,0 +1,1057 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: ForemanApi::Resources::OperatingSystem
8
+
9
+ &mdash; Documentation by YARD 0.8.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (O)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resources.html" title="ForemanApi::Resources (module)">Resources</a></span></span>
36
+ &raquo;
37
+ <span class="title">OperatingSystem</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: ForemanApi::Resources::OperatingSystem
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Base</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Base</li>
82
+
83
+ <li class="next">ForemanApi::Resources::OperatingSystem</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/foreman_api/resources/operating_system.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <h2>
113
+ Class Method Summary
114
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
115
+ </h2>
116
+
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <span class="summary_desc"><div class='inline'></div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+ <h2>
144
+ Instance Method Summary
145
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
146
+ </h2>
147
+
148
+ <ul class="summary">
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#bootfiles-instance_method" title="#bootfiles (instance method)">- (Object) <strong>bootfiles</strong>(params = { }, headers = { }) </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'></div></span>
168
+
169
+ </li>
170
+
171
+
172
+ <li class="public ">
173
+ <span class="summary_signature">
174
+
175
+ <a href="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</strong>(params = { }, headers = { }) </a>
176
+
177
+
178
+
179
+ </span>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'></div></span>
190
+
191
+ </li>
192
+
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong>(params = { }, headers = { }) </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'></div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</strong>(params = { }, headers = { }) </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'></div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#show-instance_method" title="#show (instance method)">- (Object) <strong>show</strong>(params = { }, headers = { }) </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <span class="summary_desc"><div class='inline'></div></span>
256
+
257
+ </li>
258
+
259
+
260
+ <li class="public ">
261
+ <span class="summary_signature">
262
+
263
+ <a href="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</strong>(params = { }, headers = { }) </a>
264
+
265
+
266
+
267
+ </span>
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+ <span class="summary_desc"><div class='inline'></div></span>
278
+
279
+ </li>
280
+
281
+
282
+ </ul>
283
+
284
+
285
+
286
+
287
+
288
+ <div id="class_method_details" class="method_details_list">
289
+ <h2>Class Method Details</h2>
290
+
291
+
292
+ <div class="method_details first">
293
+ <h3 class="signature first" id="doc-class_method">
294
+
295
+ + (<tt>Object</tt>) <strong>doc</strong>
296
+
297
+
298
+
299
+
300
+
301
+ </h3><table class="source_code">
302
+ <tr>
303
+ <td>
304
+ <pre class="lines">
305
+
306
+
307
+ 4
308
+ 5
309
+ 6</pre>
310
+ </td>
311
+ <td>
312
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 4</span>
313
+
314
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
315
+ <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'>operatingsystems</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
316
+ <span class='kw'>end</span></pre>
317
+ </td>
318
+ </tr>
319
+ </table>
320
+ </div>
321
+
322
+ </div>
323
+
324
+ <div id="instance_method_details" class="method_details_list">
325
+ <h2>Instance Method Details</h2>
326
+
327
+
328
+ <div class="method_details first">
329
+ <h3 class="signature first" id="bootfiles-instance_method">
330
+
331
+ - (<tt>Object</tt>) <strong>bootfiles</strong>(params = { }, headers = { })
332
+
333
+
334
+
335
+
336
+
337
+ </h3><div class="docstring">
338
+ <div class="discussion">
339
+
340
+
341
+ </div>
342
+ </div>
343
+ <div class="tags">
344
+ <p class="tag_title">Parameters:</p>
345
+ <ul class="param">
346
+
347
+ <li>
348
+
349
+ <span class='name'>params</span>
350
+
351
+
352
+ <span class='type'>(<tt>Hash</tt>)</span>
353
+
354
+
355
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
356
+
357
+
358
+ &mdash;
359
+ <div class='inline'>
360
+ <p>a hash of params to be passed to the service</p>
361
+ </div>
362
+
363
+ </li>
364
+
365
+ <li>
366
+
367
+ <span class='name'>headers</span>
368
+
369
+
370
+ <span class='type'>(<tt>Hash</tt>)</span>
371
+
372
+
373
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
374
+
375
+
376
+ &mdash;
377
+ <div class='inline'>
378
+ <p>additional http headers</p>
379
+ </div>
380
+
381
+ </li>
382
+
383
+ </ul>
384
+
385
+
386
+
387
+
388
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
389
+ <ul class="option">
390
+
391
+ <li>
392
+ <span class="name">id</span>
393
+ <span class="type">(<tt>String</tt>)</span>
394
+ <span class="default">
395
+
396
+ </span>
397
+
398
+ </li>
399
+
400
+ <li>
401
+ <span class="name">architecture</span>
402
+ <span class="type">(<tt>String</tt>)</span>
403
+ <span class="default">
404
+
405
+ </span>
406
+
407
+ </li>
408
+
409
+ <li>
410
+ <span class="name">medium</span>
411
+ <span class="type">(<tt>String</tt>)</span>
412
+ <span class="default">
413
+
414
+ </span>
415
+
416
+ </li>
417
+
418
+ </ul>
419
+
420
+
421
+
422
+
423
+
424
+ </div><table class="source_code">
425
+ <tr>
426
+ <td>
427
+ <pre class="lines">
428
+
429
+
430
+ 80
431
+ 81
432
+ 82
433
+ 83
434
+ 84</pre>
435
+ </td>
436
+ <td>
437
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 80</span>
438
+
439
+ <span class='kw'>def</span> <span class='id identifier rubyid_bootfiles'>bootfiles</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>
440
+ <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>
441
+ <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/operatingsystems/:id/bootfiles</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
442
+ <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>
443
+ <span class='kw'>end</span></pre>
444
+ </td>
445
+ </tr>
446
+ </table>
447
+ </div>
448
+
449
+ <div class="method_details ">
450
+ <h3 class="signature " id="create-instance_method">
451
+
452
+ - (<tt>Object</tt>) <strong>create</strong>(params = { }, headers = { })
453
+
454
+
455
+
456
+
457
+
458
+ </h3><div class="docstring">
459
+ <div class="discussion">
460
+
461
+
462
+ </div>
463
+ </div>
464
+ <div class="tags">
465
+ <p class="tag_title">Parameters:</p>
466
+ <ul class="param">
467
+
468
+ <li>
469
+
470
+ <span class='name'>params</span>
471
+
472
+
473
+ <span class='type'>(<tt>Hash</tt>)</span>
474
+
475
+
476
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
477
+
478
+
479
+ &mdash;
480
+ <div class='inline'>
481
+ <p>a hash of params to be passed to the service</p>
482
+ </div>
483
+
484
+ </li>
485
+
486
+ <li>
487
+
488
+ <span class='name'>headers</span>
489
+
490
+
491
+ <span class='type'>(<tt>Hash</tt>)</span>
492
+
493
+
494
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
495
+
496
+
497
+ &mdash;
498
+ <div class='inline'>
499
+ <p>additional http headers</p>
500
+ </div>
501
+
502
+ </li>
503
+
504
+ </ul>
505
+
506
+
507
+
508
+
509
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
510
+ <ul class="option">
511
+
512
+ <li>
513
+ <span class="name">operatingsystem</span>
514
+ <span class="type">(<tt>Hash</tt>)</span>
515
+ <span class="default">
516
+
517
+ </span>
518
+
519
+ &mdash; <div class='inline'>
520
+ <p>allowed keys are:</p>
521
+ <ul><li>
522
+ <p>family [String],</p>
523
+ </li><li>
524
+ <p>major [String],</p>
525
+ </li><li>
526
+ <p>minor [String],</p>
527
+ </li><li>
528
+ <p>name [String],</p>
529
+ </li><li>
530
+ <p>release_name [String],</p>
531
+ </li></ul>
532
+ </div>
533
+
534
+ </li>
535
+
536
+ </ul>
537
+
538
+
539
+
540
+
541
+
542
+ </div><table class="source_code">
543
+ <tr>
544
+ <td>
545
+ <pre class="lines">
546
+
547
+
548
+ 41
549
+ 42
550
+ 43
551
+ 44
552
+ 45</pre>
553
+ </td>
554
+ <td>
555
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 41</span>
556
+
557
+ <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>
558
+ <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>
559
+ <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/operatingsystems</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
560
+ <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>
561
+ <span class='kw'>end</span></pre>
562
+ </td>
563
+ </tr>
564
+ </table>
565
+ </div>
566
+
567
+ <div class="method_details ">
568
+ <h3 class="signature " id="destroy-instance_method">
569
+
570
+ - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
571
+
572
+
573
+
574
+
575
+
576
+ </h3><div class="docstring">
577
+ <div class="discussion">
578
+
579
+
580
+ </div>
581
+ </div>
582
+ <div class="tags">
583
+ <p class="tag_title">Parameters:</p>
584
+ <ul class="param">
585
+
586
+ <li>
587
+
588
+ <span class='name'>params</span>
589
+
590
+
591
+ <span class='type'>(<tt>Hash</tt>)</span>
592
+
593
+
594
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
595
+
596
+
597
+ &mdash;
598
+ <div class='inline'>
599
+ <p>a hash of params to be passed to the service</p>
600
+ </div>
601
+
602
+ </li>
603
+
604
+ <li>
605
+
606
+ <span class='name'>headers</span>
607
+
608
+
609
+ <span class='type'>(<tt>Hash</tt>)</span>
610
+
611
+
612
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
613
+
614
+
615
+ &mdash;
616
+ <div class='inline'>
617
+ <p>additional http headers</p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ </ul>
623
+
624
+
625
+
626
+
627
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
628
+ <ul class="option">
629
+
630
+ <li>
631
+ <span class="name">id</span>
632
+ <span class="type">(<tt>String</tt>)</span>
633
+ <span class="default">
634
+
635
+ </span>
636
+
637
+ </li>
638
+
639
+ </ul>
640
+
641
+
642
+
643
+
644
+
645
+ </div><table class="source_code">
646
+ <tr>
647
+ <td>
648
+ <pre class="lines">
649
+
650
+
651
+ 68
652
+ 69
653
+ 70
654
+ 71
655
+ 72</pre>
656
+ </td>
657
+ <td>
658
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 68</span>
659
+
660
+ <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>
661
+ <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>
662
+ <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/operatingsystems/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
663
+ <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>
664
+ <span class='kw'>end</span></pre>
665
+ </td>
666
+ </tr>
667
+ </table>
668
+ </div>
669
+
670
+ <div class="method_details ">
671
+ <h3 class="signature " id="index-instance_method">
672
+
673
+ - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
674
+
675
+
676
+
677
+
678
+
679
+ </h3><div class="docstring">
680
+ <div class="discussion">
681
+
682
+
683
+ </div>
684
+ </div>
685
+ <div class="tags">
686
+ <p class="tag_title">Parameters:</p>
687
+ <ul class="param">
688
+
689
+ <li>
690
+
691
+ <span class='name'>params</span>
692
+
693
+
694
+ <span class='type'>(<tt>Hash</tt>)</span>
695
+
696
+
697
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
698
+
699
+
700
+ &mdash;
701
+ <div class='inline'>
702
+ <p>a hash of params to be passed to the service</p>
703
+ </div>
704
+
705
+ </li>
706
+
707
+ <li>
708
+
709
+ <span class='name'>headers</span>
710
+
711
+
712
+ <span class='type'>(<tt>Hash</tt>)</span>
713
+
714
+
715
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
716
+
717
+
718
+ &mdash;
719
+ <div class='inline'>
720
+ <p>additional http headers</p>
721
+ </div>
722
+
723
+ </li>
724
+
725
+ </ul>
726
+
727
+
728
+
729
+
730
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
731
+ <ul class="option">
732
+
733
+ <li>
734
+ <span class="name">order</span>
735
+ <span class="type">(<tt>String</tt>)</span>
736
+ <span class="default">
737
+
738
+ </span>
739
+
740
+ &mdash; <div class='inline'>
741
+ <p>For example, name asc, or name desc</p>
742
+ </div>
743
+
744
+ </li>
745
+
746
+ <li>
747
+ <span class="name">page</span>
748
+ <span class="type">(<tt>String</tt>)</span>
749
+ <span class="default">
750
+
751
+ </span>
752
+
753
+ &mdash; <div class='inline'>
754
+ <p>Paginate results</p>
755
+ </div>
756
+
757
+ </li>
758
+
759
+ <li>
760
+ <span class="name">per_page</span>
761
+ <span class="type">(<tt>String</tt>)</span>
762
+ <span class="default">
763
+
764
+ </span>
765
+
766
+ &mdash; <div class='inline'>
767
+ <p>Number of entries per request</p>
768
+ </div>
769
+
770
+ </li>
771
+
772
+ <li>
773
+ <span class="name">search</span>
774
+ <span class="type">(<tt>String</tt>)</span>
775
+ <span class="default">
776
+
777
+ </span>
778
+
779
+ &mdash; <div class='inline'>
780
+ <p>Filter results</p>
781
+ </div>
782
+
783
+ </li>
784
+
785
+ </ul>
786
+
787
+
788
+
789
+
790
+
791
+ </div><table class="source_code">
792
+ <tr>
793
+ <td>
794
+ <pre class="lines">
795
+
796
+
797
+ 15
798
+ 16
799
+ 17
800
+ 18
801
+ 19</pre>
802
+ </td>
803
+ <td>
804
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 15</span>
805
+
806
+ <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>
807
+ <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>
808
+ <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/operatingsystems</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
809
+ <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>
810
+ <span class='kw'>end</span></pre>
811
+ </td>
812
+ </tr>
813
+ </table>
814
+ </div>
815
+
816
+ <div class="method_details ">
817
+ <h3 class="signature " id="show-instance_method">
818
+
819
+ - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
820
+
821
+
822
+
823
+
824
+
825
+ </h3><div class="docstring">
826
+ <div class="discussion">
827
+
828
+
829
+ </div>
830
+ </div>
831
+ <div class="tags">
832
+ <p class="tag_title">Parameters:</p>
833
+ <ul class="param">
834
+
835
+ <li>
836
+
837
+ <span class='name'>params</span>
838
+
839
+
840
+ <span class='type'>(<tt>Hash</tt>)</span>
841
+
842
+
843
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
844
+
845
+
846
+ &mdash;
847
+ <div class='inline'>
848
+ <p>a hash of params to be passed to the service</p>
849
+ </div>
850
+
851
+ </li>
852
+
853
+ <li>
854
+
855
+ <span class='name'>headers</span>
856
+
857
+
858
+ <span class='type'>(<tt>Hash</tt>)</span>
859
+
860
+
861
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
862
+
863
+
864
+ &mdash;
865
+ <div class='inline'>
866
+ <p>additional http headers</p>
867
+ </div>
868
+
869
+ </li>
870
+
871
+ </ul>
872
+
873
+
874
+
875
+
876
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
877
+ <ul class="option">
878
+
879
+ <li>
880
+ <span class="name">id</span>
881
+ <span class="type">(<tt>String</tt>)</span>
882
+ <span class="default">
883
+
884
+ </span>
885
+
886
+ </li>
887
+
888
+ </ul>
889
+
890
+
891
+
892
+
893
+
894
+ </div><table class="source_code">
895
+ <tr>
896
+ <td>
897
+ <pre class="lines">
898
+
899
+
900
+ 25
901
+ 26
902
+ 27
903
+ 28
904
+ 29</pre>
905
+ </td>
906
+ <td>
907
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 25</span>
908
+
909
+ <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>
910
+ <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>
911
+ <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/operatingsystems/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
912
+ <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>
913
+ <span class='kw'>end</span></pre>
914
+ </td>
915
+ </tr>
916
+ </table>
917
+ </div>
918
+
919
+ <div class="method_details ">
920
+ <h3 class="signature " id="update-instance_method">
921
+
922
+ - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
923
+
924
+
925
+
926
+
927
+
928
+ </h3><div class="docstring">
929
+ <div class="discussion">
930
+
931
+
932
+ </div>
933
+ </div>
934
+ <div class="tags">
935
+ <p class="tag_title">Parameters:</p>
936
+ <ul class="param">
937
+
938
+ <li>
939
+
940
+ <span class='name'>params</span>
941
+
942
+
943
+ <span class='type'>(<tt>Hash</tt>)</span>
944
+
945
+
946
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
947
+
948
+
949
+ &mdash;
950
+ <div class='inline'>
951
+ <p>a hash of params to be passed to the service</p>
952
+ </div>
953
+
954
+ </li>
955
+
956
+ <li>
957
+
958
+ <span class='name'>headers</span>
959
+
960
+
961
+ <span class='type'>(<tt>Hash</tt>)</span>
962
+
963
+
964
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
965
+
966
+
967
+ &mdash;
968
+ <div class='inline'>
969
+ <p>additional http headers</p>
970
+ </div>
971
+
972
+ </li>
973
+
974
+ </ul>
975
+
976
+
977
+
978
+
979
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
980
+ <ul class="option">
981
+
982
+ <li>
983
+ <span class="name">id</span>
984
+ <span class="type">(<tt>String</tt>)</span>
985
+ <span class="default">
986
+
987
+ </span>
988
+
989
+ </li>
990
+
991
+ <li>
992
+ <span class="name">operatingsystem</span>
993
+ <span class="type">(<tt>Hash</tt>)</span>
994
+ <span class="default">
995
+
996
+ </span>
997
+
998
+ &mdash; <div class='inline'>
999
+ <p>allowed keys are:</p>
1000
+ <ul><li>
1001
+ <p>family [String],</p>
1002
+ </li><li>
1003
+ <p>major [String],</p>
1004
+ </li><li>
1005
+ <p>minor [String],</p>
1006
+ </li><li>
1007
+ <p>name [String],</p>
1008
+ </li><li>
1009
+ <p>release_name [String],</p>
1010
+ </li></ul>
1011
+ </div>
1012
+
1013
+ </li>
1014
+
1015
+ </ul>
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+ </div><table class="source_code">
1022
+ <tr>
1023
+ <td>
1024
+ <pre class="lines">
1025
+
1026
+
1027
+ 58
1028
+ 59
1029
+ 60
1030
+ 61
1031
+ 62</pre>
1032
+ </td>
1033
+ <td>
1034
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/operating_system.rb', line 58</span>
1035
+
1036
+ <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>
1037
+ <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>
1038
+ <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/operatingsystems/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
1039
+ <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>
1040
+ <span class='kw'>end</span></pre>
1041
+ </td>
1042
+ </tr>
1043
+ </table>
1044
+ </div>
1045
+
1046
+ </div>
1047
+
1048
+ </div>
1049
+
1050
+ <div id="footer">
1051
+ Generated on Mon Jan 21 15:44:36 2013 by
1052
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1053
+ 0.8.3 (ruby-1.9.3).
1054
+ </div>
1055
+
1056
+ </body>
1057
+ </html>