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/CommonParameter.html ADDED
@@ -0,0 +1,902 @@
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::CommonParameter
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 (C)</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">CommonParameter</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::CommonParameter
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::CommonParameter</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/common_parameter.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="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</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="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</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="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</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="#show-instance_method" title="#show (instance method)">- (Object) <strong>show</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="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</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
+ </ul>
261
+
262
+
263
+
264
+
265
+
266
+ <div id="class_method_details" class="method_details_list">
267
+ <h2>Class Method Details</h2>
268
+
269
+
270
+ <div class="method_details first">
271
+ <h3 class="signature first" id="doc-class_method">
272
+
273
+ + (<tt>Object</tt>) <strong>doc</strong>
274
+
275
+
276
+
277
+
278
+
279
+ </h3><table class="source_code">
280
+ <tr>
281
+ <td>
282
+ <pre class="lines">
283
+
284
+
285
+ 4
286
+ 5
287
+ 6</pre>
288
+ </td>
289
+ <td>
290
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 4</span>
291
+
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>
295
+ </td>
296
+ </tr>
297
+ </table>
298
+ </div>
299
+
300
+ </div>
301
+
302
+ <div id="instance_method_details" class="method_details_list">
303
+ <h2>Instance Method Details</h2>
304
+
305
+
306
+ <div class="method_details first">
307
+ <h3 class="signature first" id="create-instance_method">
308
+
309
+ - (<tt>Object</tt>) <strong>create</strong>(params = { }, headers = { })
310
+
311
+
312
+
313
+
314
+
315
+ </h3><div class="docstring">
316
+ <div class="discussion">
317
+
318
+
319
+ </div>
320
+ </div>
321
+ <div class="tags">
322
+ <p class="tag_title">Parameters:</p>
323
+ <ul class="param">
324
+
325
+ <li>
326
+
327
+ <span class='name'>params</span>
328
+
329
+
330
+ <span class='type'>(<tt>Hash</tt>)</span>
331
+
332
+
333
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
334
+
335
+
336
+ &mdash;
337
+ <div class='inline'>
338
+ <p>a hash of params to be passed to the service</p>
339
+ </div>
340
+
341
+ </li>
342
+
343
+ <li>
344
+
345
+ <span class='name'>headers</span>
346
+
347
+
348
+ <span class='type'>(<tt>Hash</tt>)</span>
349
+
350
+
351
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
352
+
353
+
354
+ &mdash;
355
+ <div class='inline'>
356
+ <p>additional http headers</p>
357
+ </div>
358
+
359
+ </li>
360
+
361
+ </ul>
362
+
363
+
364
+
365
+
366
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
367
+ <ul class="option">
368
+
369
+ <li>
370
+ <span class="name">common_parameter</span>
371
+ <span class="type">(<tt>Hash</tt>)</span>
372
+ <span class="default">
373
+
374
+ </span>
375
+
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>
383
+ </div>
384
+
385
+ </li>
386
+
387
+ </ul>
388
+
389
+
390
+
391
+
392
+
393
+ </div><table class="source_code">
394
+ <tr>
395
+ <td>
396
+ <pre class="lines">
397
+
398
+
399
+ 38
400
+ 39
401
+ 40
402
+ 41
403
+ 42</pre>
404
+ </td>
405
+ <td>
406
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 38</span>
407
+
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>
413
+ </td>
414
+ </tr>
415
+ </table>
416
+ </div>
417
+
418
+ <div class="method_details ">
419
+ <h3 class="signature " id="destroy-instance_method">
420
+
421
+ - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
422
+
423
+
424
+
425
+
426
+
427
+ </h3><div class="docstring">
428
+ <div class="discussion">
429
+
430
+
431
+ </div>
432
+ </div>
433
+ <div class="tags">
434
+ <p class="tag_title">Parameters:</p>
435
+ <ul class="param">
436
+
437
+ <li>
438
+
439
+ <span class='name'>params</span>
440
+
441
+
442
+ <span class='type'>(<tt>Hash</tt>)</span>
443
+
444
+
445
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
446
+
447
+
448
+ &mdash;
449
+ <div class='inline'>
450
+ <p>a hash of params to be passed to the service</p>
451
+ </div>
452
+
453
+ </li>
454
+
455
+ <li>
456
+
457
+ <span class='name'>headers</span>
458
+
459
+
460
+ <span class='type'>(<tt>Hash</tt>)</span>
461
+
462
+
463
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
464
+
465
+
466
+ &mdash;
467
+ <div class='inline'>
468
+ <p>additional http headers</p>
469
+ </div>
470
+
471
+ </li>
472
+
473
+ </ul>
474
+
475
+
476
+
477
+
478
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
479
+ <ul class="option">
480
+
481
+ <li>
482
+ <span class="name">id</span>
483
+ <span class="type">(<tt>String</tt>)</span>
484
+ <span class="default">
485
+
486
+ </span>
487
+
488
+ </li>
489
+
490
+ </ul>
491
+
492
+
493
+
494
+
495
+
496
+ </div><table class="source_code">
497
+ <tr>
498
+ <td>
499
+ <pre class="lines">
500
+
501
+
502
+ 62
503
+ 63
504
+ 64
505
+ 65
506
+ 66</pre>
507
+ </td>
508
+ <td>
509
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 62</span>
510
+
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>
516
+ </td>
517
+ </tr>
518
+ </table>
519
+ </div>
520
+
521
+ <div class="method_details ">
522
+ <h3 class="signature " id="index-instance_method">
523
+
524
+ - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
525
+
526
+
527
+
528
+
529
+
530
+ </h3><div class="docstring">
531
+ <div class="discussion">
532
+
533
+
534
+ </div>
535
+ </div>
536
+ <div class="tags">
537
+ <p class="tag_title">Parameters:</p>
538
+ <ul class="param">
539
+
540
+ <li>
541
+
542
+ <span class='name'>params</span>
543
+
544
+
545
+ <span class='type'>(<tt>Hash</tt>)</span>
546
+
547
+
548
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
549
+
550
+
551
+ &mdash;
552
+ <div class='inline'>
553
+ <p>a hash of params to be passed to the service</p>
554
+ </div>
555
+
556
+ </li>
557
+
558
+ <li>
559
+
560
+ <span class='name'>headers</span>
561
+
562
+
563
+ <span class='type'>(<tt>Hash</tt>)</span>
564
+
565
+
566
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
567
+
568
+
569
+ &mdash;
570
+ <div class='inline'>
571
+ <p>additional http headers</p>
572
+ </div>
573
+
574
+ </li>
575
+
576
+ </ul>
577
+
578
+
579
+
580
+
581
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
582
+ <ul class="option">
583
+
584
+ <li>
585
+ <span class="name">order</span>
586
+ <span class="type">(<tt>String</tt>)</span>
587
+ <span class="default">
588
+
589
+ </span>
590
+
591
+ &mdash; <div class='inline'>
592
+ <p>Sort results</p>
593
+ </div>
594
+
595
+ </li>
596
+
597
+ <li>
598
+ <span class="name">page</span>
599
+ <span class="type">(<tt>String</tt>)</span>
600
+ <span class="default">
601
+
602
+ </span>
603
+
604
+ &mdash; <div class='inline'>
605
+ <p>Paginate results</p>
606
+ </div>
607
+
608
+ </li>
609
+
610
+ <li>
611
+ <span class="name">per_page</span>
612
+ <span class="type">(<tt>String</tt>)</span>
613
+ <span class="default">
614
+
615
+ </span>
616
+
617
+ &mdash; <div class='inline'>
618
+ <p>Number of entries per request</p>
619
+ </div>
620
+
621
+ </li>
622
+
623
+ <li>
624
+ <span class="name">search</span>
625
+ <span class="type">(<tt>String</tt>)</span>
626
+ <span class="default">
627
+
628
+ </span>
629
+
630
+ &mdash; <div class='inline'>
631
+ <p>Filter results</p>
632
+ </div>
633
+
634
+ </li>
635
+
636
+ </ul>
637
+
638
+
639
+
640
+
641
+
642
+ </div><table class="source_code">
643
+ <tr>
644
+ <td>
645
+ <pre class="lines">
646
+
647
+
648
+ 15
649
+ 16
650
+ 17
651
+ 18
652
+ 19</pre>
653
+ </td>
654
+ <td>
655
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 15</span>
656
+
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>
662
+ </td>
663
+ </tr>
664
+ </table>
665
+ </div>
666
+
667
+ <div class="method_details ">
668
+ <h3 class="signature " id="show-instance_method">
669
+
670
+ - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
671
+
672
+
673
+
674
+
675
+
676
+ </h3><div class="docstring">
677
+ <div class="discussion">
678
+
679
+
680
+ </div>
681
+ </div>
682
+ <div class="tags">
683
+ <p class="tag_title">Parameters:</p>
684
+ <ul class="param">
685
+
686
+ <li>
687
+
688
+ <span class='name'>params</span>
689
+
690
+
691
+ <span class='type'>(<tt>Hash</tt>)</span>
692
+
693
+
694
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
695
+
696
+
697
+ &mdash;
698
+ <div class='inline'>
699
+ <p>a hash of params to be passed to the service</p>
700
+ </div>
701
+
702
+ </li>
703
+
704
+ <li>
705
+
706
+ <span class='name'>headers</span>
707
+
708
+
709
+ <span class='type'>(<tt>Hash</tt>)</span>
710
+
711
+
712
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
713
+
714
+
715
+ &mdash;
716
+ <div class='inline'>
717
+ <p>additional http headers</p>
718
+ </div>
719
+
720
+ </li>
721
+
722
+ </ul>
723
+
724
+
725
+
726
+
727
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
728
+ <ul class="option">
729
+
730
+ <li>
731
+ <span class="name">id</span>
732
+ <span class="type">(<tt>String</tt>)</span>
733
+ <span class="default">
734
+
735
+ </span>
736
+
737
+ </li>
738
+
739
+ </ul>
740
+
741
+
742
+
743
+
744
+
745
+ </div><table class="source_code">
746
+ <tr>
747
+ <td>
748
+ <pre class="lines">
749
+
750
+
751
+ 25
752
+ 26
753
+ 27
754
+ 28
755
+ 29</pre>
756
+ </td>
757
+ <td>
758
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 25</span>
759
+
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>
765
+ </td>
766
+ </tr>
767
+ </table>
768
+ </div>
769
+
770
+ <div class="method_details ">
771
+ <h3 class="signature " id="update-instance_method">
772
+
773
+ - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
774
+
775
+
776
+
777
+
778
+
779
+ </h3><div class="docstring">
780
+ <div class="discussion">
781
+
782
+
783
+ </div>
784
+ </div>
785
+ <div class="tags">
786
+ <p class="tag_title">Parameters:</p>
787
+ <ul class="param">
788
+
789
+ <li>
790
+
791
+ <span class='name'>params</span>
792
+
793
+
794
+ <span class='type'>(<tt>Hash</tt>)</span>
795
+
796
+
797
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
798
+
799
+
800
+ &mdash;
801
+ <div class='inline'>
802
+ <p>a hash of params to be passed to the service</p>
803
+ </div>
804
+
805
+ </li>
806
+
807
+ <li>
808
+
809
+ <span class='name'>headers</span>
810
+
811
+
812
+ <span class='type'>(<tt>Hash</tt>)</span>
813
+
814
+
815
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
816
+
817
+
818
+ &mdash;
819
+ <div class='inline'>
820
+ <p>additional http headers</p>
821
+ </div>
822
+
823
+ </li>
824
+
825
+ </ul>
826
+
827
+
828
+
829
+
830
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
831
+ <ul class="option">
832
+
833
+ <li>
834
+ <span class="name">id</span>
835
+ <span class="type">(<tt>String</tt>)</span>
836
+ <span class="default">
837
+
838
+ </span>
839
+
840
+ </li>
841
+
842
+ <li>
843
+ <span class="name">common_parameter</span>
844
+ <span class="type">(<tt>Hash</tt>)</span>
845
+ <span class="default">
846
+
847
+ </span>
848
+
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>
856
+ </div>
857
+
858
+ </li>
859
+
860
+ </ul>
861
+
862
+
863
+
864
+
865
+
866
+ </div><table class="source_code">
867
+ <tr>
868
+ <td>
869
+ <pre class="lines">
870
+
871
+
872
+ 52
873
+ 53
874
+ 54
875
+ 55
876
+ 56</pre>
877
+ </td>
878
+ <td>
879
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/common_parameter.rb', line 52</span>
880
+
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>
886
+ </td>
887
+ </tr>
888
+ </table>
889
+ </div>
890
+
891
+ </div>
892
+
893
+ </div>
894
+
895
+ <div id="footer">
896
+ Generated on Mon Jan 21 15:44:37 2013 by
897
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
898
+ 0.8.3 (ruby-1.9.3).
899
+ </div>
900
+
901
+ </body>
902
+ </html>