foreman_api 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. data/README.rdoc +35 -18
  2. data/doc/ForemanApi/Resources/Architecture.html +93 -136
  3. data/doc/ForemanApi/Resources/Audit.html +42 -60
  4. data/doc/ForemanApi/Resources/AuthSourceLdap.html +129 -190
  5. data/doc/ForemanApi/Resources/Bookmark.html +97 -142
  6. data/doc/ForemanApi/Resources/CommonParameter.html +93 -136
  7. data/doc/ForemanApi/Resources/ComputeResource.html +131 -190
  8. data/doc/ForemanApi/Resources/ConfigTemplate.html +145 -211
  9. data/doc/ForemanApi/Resources/Dashboard.html +21 -29
  10. data/doc/ForemanApi/Resources/Domain.html +103 -151
  11. data/doc/ForemanApi/Resources/Environment.html +89 -130
  12. data/doc/ForemanApi/Resources/FactValue.html +29 -41
  13. data/doc/ForemanApi/Resources/Home.html +32 -45
  14. data/doc/ForemanApi/Resources/Host.html +317 -251
  15. data/doc/ForemanApi/Resources/HostClass.html +55 -79
  16. data/doc/ForemanApi/Resources/Hostgroup.html +125 -184
  17. data/doc/ForemanApi/Resources/HostgroupClass.html +57 -82
  18. data/doc/ForemanApi/Resources/Image.html +109 -160
  19. data/doc/ForemanApi/Resources/Location.html +937 -0
  20. data/doc/ForemanApi/Resources/LookupKey.html +111 -163
  21. data/doc/ForemanApi/Resources/Medium.html +113 -154
  22. data/doc/ForemanApi/Resources/Model.html +101 -148
  23. data/doc/ForemanApi/Resources/OperatingSystem.html +118 -173
  24. data/doc/ForemanApi/Resources/Organization.html +937 -0
  25. data/doc/ForemanApi/Resources/Parameter.html +158 -233
  26. data/doc/ForemanApi/Resources/Ptable.html +97 -142
  27. data/doc/ForemanApi/Resources/Puppetclass.html +95 -139
  28. data/doc/ForemanApi/Resources/Report.html +68 -98
  29. data/doc/ForemanApi/Resources/Role.html +85 -124
  30. data/doc/ForemanApi/Resources/Setting.html +58 -84
  31. data/doc/ForemanApi/Resources/SmartProxy.html +91 -133
  32. data/doc/ForemanApi/Resources/Subnet.html +141 -208
  33. data/doc/ForemanApi/Resources/TemplateCombination.html +65 -94
  34. data/doc/ForemanApi/Resources/TemplateKind.html +23 -32
  35. data/doc/ForemanApi/Resources/User.html +111 -163
  36. data/doc/ForemanApi/Resources/Usergroup.html +89 -130
  37. data/doc/ForemanApi/Resources.html +6 -6
  38. data/doc/ForemanApi.html +5 -5
  39. data/doc/_index.html +18 -4
  40. data/doc/class_list.html +1 -1
  41. data/doc/css/style.css +0 -10
  42. data/doc/file.MIT-LICENSE.html +24 -29
  43. data/doc/file.README.html +81 -60
  44. data/doc/frames.html +1 -1
  45. data/doc/index.html +81 -60
  46. data/doc/method_list.html +416 -312
  47. data/doc/top-level-namespace.html +3 -3
  48. data/lib/foreman_api/base.rb +16 -8
  49. data/lib/foreman_api/documentation.json +1 -1
  50. data/lib/foreman_api/resources/host.rb +9 -0
  51. data/lib/foreman_api/resources/location.rb +59 -0
  52. data/lib/foreman_api/resources/medium.rb +2 -2
  53. data/lib/foreman_api/resources/organization.rb +59 -0
  54. data/lib/foreman_api/version.rb +1 -1
  55. metadata +7 -3
data/doc/ForemanApi/Resources/Location.html ADDED
@@ -0,0 +1,937 @@
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::Location
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 (L)</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">Location</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::Location
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::Location</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/location.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)">- (Array) <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'>
168
+ <p>First item: parsed data; second item: raw body.</p>
169
+ </div></span>
170
+
171
+ </li>
172
+
173
+
174
+ <li class="public ">
175
+ <span class="summary_signature">
176
+
177
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
178
+
179
+
180
+
181
+ </span>
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <span class="summary_desc"><div class='inline'>
192
+ <p>First item: parsed data; second item: raw body.</p>
193
+ </div></span>
194
+
195
+ </li>
196
+
197
+
198
+ <li class="public ">
199
+ <span class="summary_signature">
200
+
201
+ <a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
202
+
203
+
204
+
205
+ </span>
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <span class="summary_desc"><div class='inline'>
216
+ <p>First item: parsed data; second item: raw body.</p>
217
+ </div></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <span class="summary_desc"><div class='inline'>
240
+ <p>First item: parsed data; second item: raw body.</p>
241
+ </div></span>
242
+
243
+ </li>
244
+
245
+
246
+ <li class="public ">
247
+ <span class="summary_signature">
248
+
249
+ <a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
250
+
251
+
252
+
253
+ </span>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+ <span class="summary_desc"><div class='inline'>
264
+ <p>First item: parsed data; second item: raw body.</p>
265
+ </div></span>
266
+
267
+ </li>
268
+
269
+
270
+ </ul>
271
+
272
+
273
+
274
+
275
+
276
+ <div id="class_method_details" class="method_details_list">
277
+ <h2>Class Method Details</h2>
278
+
279
+
280
+ <div class="method_details first">
281
+ <h3 class="signature first" id="doc-class_method">
282
+
283
+ + (<tt>Object</tt>) <strong>doc</strong>
284
+
285
+
286
+
287
+
288
+
289
+ </h3><table class="source_code">
290
+ <tr>
291
+ <td>
292
+ <pre class="lines">
293
+
294
+
295
+ 4
296
+ 5
297
+ 6</pre>
298
+ </td>
299
+ <td>
300
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/location.rb', line 4</span>
301
+
302
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
303
+ <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'>locations</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
304
+ <span class='kw'>end</span></pre>
305
+ </td>
306
+ </tr>
307
+ </table>
308
+ </div>
309
+
310
+ </div>
311
+
312
+ <div id="instance_method_details" class="method_details_list">
313
+ <h2>Instance Method Details</h2>
314
+
315
+
316
+ <div class="method_details first">
317
+ <h3 class="signature first" id="create-instance_method">
318
+
319
+ - (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
320
+
321
+
322
+
323
+
324
+
325
+ </h3><div class="docstring">
326
+ <div class="discussion">
327
+
328
+ <p>First item: parsed data; second item: raw body</p>
329
+
330
+
331
+ </div>
332
+ </div>
333
+ <div class="tags">
334
+ <p class="tag_title">Parameters:</p>
335
+ <ul class="param">
336
+
337
+ <li>
338
+
339
+ <span class='name'>params</span>
340
+
341
+
342
+ <span class='type'>(<tt>Hash</tt>)</span>
343
+
344
+
345
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
346
+
347
+
348
+ &mdash;
349
+ <div class='inline'>
350
+ <p>a hash of params to be passed to the service</p>
351
+ </div>
352
+
353
+ </li>
354
+
355
+ <li>
356
+
357
+ <span class='name'>headers</span>
358
+
359
+
360
+ <span class='type'>(<tt>Hash</tt>)</span>
361
+
362
+
363
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
364
+
365
+
366
+ &mdash;
367
+ <div class='inline'>
368
+ <p>additional http headers</p>
369
+ </div>
370
+
371
+ </li>
372
+
373
+ </ul>
374
+
375
+
376
+
377
+
378
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
379
+ <ul class="option">
380
+
381
+ <li>
382
+ <span class="name">locations</span>
383
+ <span class="type">(<tt>Hash</tt>)</span>
384
+ <span class="default">
385
+
386
+ </span>
387
+
388
+ &mdash; <div class='inline'>
389
+ <p>allowed keys are:</p>
390
+ <ul><li>
391
+ <p>:name [String]</p>
392
+ </li></ul>
393
+ </div>
394
+
395
+ </li>
396
+
397
+ </ul>
398
+
399
+
400
+
401
+
402
+ <p class="tag_title">Returns:</p>
403
+ <ul class="return">
404
+
405
+ <li>
406
+
407
+
408
+ <span class='type'>(<tt>Array</tt>)</span>
409
+
410
+
411
+
412
+ &mdash;
413
+ <div class='inline'>
414
+ <p>First item: parsed data; second item: raw body</p>
415
+ </div>
416
+
417
+ </li>
418
+
419
+ </ul>
420
+
421
+ </div><table class="source_code">
422
+ <tr>
423
+ <td>
424
+ <pre class="lines">
425
+
426
+
427
+ 32
428
+ 33
429
+ 34</pre>
430
+ </td>
431
+ <td>
432
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/location.rb', line 32</span>
433
+
434
+ <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>
435
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
436
+ <span class='kw'>end</span></pre>
437
+ </td>
438
+ </tr>
439
+ </table>
440
+ </div>
441
+
442
+ <div class="method_details ">
443
+ <h3 class="signature " id="destroy-instance_method">
444
+
445
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
446
+
447
+
448
+
449
+
450
+
451
+ </h3><div class="docstring">
452
+ <div class="discussion">
453
+
454
+ <p>First item: parsed data; second item: raw body</p>
455
+
456
+
457
+ </div>
458
+ </div>
459
+ <div class="tags">
460
+ <p class="tag_title">Parameters:</p>
461
+ <ul class="param">
462
+
463
+ <li>
464
+
465
+ <span class='name'>params</span>
466
+
467
+
468
+ <span class='type'>(<tt>Hash</tt>)</span>
469
+
470
+
471
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
472
+
473
+
474
+ &mdash;
475
+ <div class='inline'>
476
+ <p>a hash of params to be passed to the service</p>
477
+ </div>
478
+
479
+ </li>
480
+
481
+ <li>
482
+
483
+ <span class='name'>headers</span>
484
+
485
+
486
+ <span class='type'>(<tt>Hash</tt>)</span>
487
+
488
+
489
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
490
+
491
+
492
+ &mdash;
493
+ <div class='inline'>
494
+ <p>additional http headers</p>
495
+ </div>
496
+
497
+ </li>
498
+
499
+ </ul>
500
+
501
+
502
+
503
+
504
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
505
+ <ul class="option">
506
+
507
+ <li>
508
+ <span class="name">id</span>
509
+ <span class="type">(<tt>Object</tt>)</span>
510
+ <span class="default">
511
+
512
+ </span>
513
+
514
+ &mdash; <div class='inline'>
515
+ <p>Part of <tt>/api/locations/:id</tt> path</p>
516
+ </div>
517
+
518
+ </li>
519
+
520
+ </ul>
521
+
522
+
523
+
524
+
525
+ <p class="tag_title">Returns:</p>
526
+ <ul class="return">
527
+
528
+ <li>
529
+
530
+
531
+ <span class='type'>(<tt>Array</tt>)</span>
532
+
533
+
534
+
535
+ &mdash;
536
+ <div class='inline'>
537
+ <p>First item: parsed data; second item: raw body</p>
538
+ </div>
539
+
540
+ </li>
541
+
542
+ </ul>
543
+
544
+ </div><table class="source_code">
545
+ <tr>
546
+ <td>
547
+ <pre class="lines">
548
+
549
+
550
+ 53
551
+ 54
552
+ 55</pre>
553
+ </td>
554
+ <td>
555
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/location.rb', line 53</span>
556
+
557
+ <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>
558
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
559
+ <span class='kw'>end</span></pre>
560
+ </td>
561
+ </tr>
562
+ </table>
563
+ </div>
564
+
565
+ <div class="method_details ">
566
+ <h3 class="signature " id="index-instance_method">
567
+
568
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
569
+
570
+
571
+
572
+
573
+
574
+ </h3><div class="docstring">
575
+ <div class="discussion">
576
+
577
+ <p>First item: parsed data; second item: raw body</p>
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
+ <p class="tag_title">Returns:</p>
625
+ <ul class="return">
626
+
627
+ <li>
628
+
629
+
630
+ <span class='type'>(<tt>Array</tt>)</span>
631
+
632
+
633
+
634
+ &mdash;
635
+ <div class='inline'>
636
+ <p>First item: parsed data; second item: raw body</p>
637
+ </div>
638
+
639
+ </li>
640
+
641
+ </ul>
642
+
643
+ </div><table class="source_code">
644
+ <tr>
645
+ <td>
646
+ <pre class="lines">
647
+
648
+
649
+ 12
650
+ 13
651
+ 14</pre>
652
+ </td>
653
+ <td>
654
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/location.rb', line 12</span>
655
+
656
+ <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>
657
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
658
+ <span class='kw'>end</span></pre>
659
+ </td>
660
+ </tr>
661
+ </table>
662
+ </div>
663
+
664
+ <div class="method_details ">
665
+ <h3 class="signature " id="show-instance_method">
666
+
667
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
668
+
669
+
670
+
671
+
672
+
673
+ </h3><div class="docstring">
674
+ <div class="discussion">
675
+
676
+ <p>First item: parsed data; second item: raw body</p>
677
+
678
+
679
+ </div>
680
+ </div>
681
+ <div class="tags">
682
+ <p class="tag_title">Parameters:</p>
683
+ <ul class="param">
684
+
685
+ <li>
686
+
687
+ <span class='name'>params</span>
688
+
689
+
690
+ <span class='type'>(<tt>Hash</tt>)</span>
691
+
692
+
693
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
694
+
695
+
696
+ &mdash;
697
+ <div class='inline'>
698
+ <p>a hash of params to be passed to the service</p>
699
+ </div>
700
+
701
+ </li>
702
+
703
+ <li>
704
+
705
+ <span class='name'>headers</span>
706
+
707
+
708
+ <span class='type'>(<tt>Hash</tt>)</span>
709
+
710
+
711
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
712
+
713
+
714
+ &mdash;
715
+ <div class='inline'>
716
+ <p>additional http headers</p>
717
+ </div>
718
+
719
+ </li>
720
+
721
+ </ul>
722
+
723
+
724
+
725
+
726
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
727
+ <ul class="option">
728
+
729
+ <li>
730
+ <span class="name">id</span>
731
+ <span class="type">(<tt>Object</tt>)</span>
732
+ <span class="default">
733
+
734
+ </span>
735
+
736
+ &mdash; <div class='inline'>
737
+ <p>Part of <tt>/api/locations/:id</tt> path</p>
738
+ </div>
739
+
740
+ </li>
741
+
742
+ </ul>
743
+
744
+
745
+
746
+
747
+ <p class="tag_title">Returns:</p>
748
+ <ul class="return">
749
+
750
+ <li>
751
+
752
+
753
+ <span class='type'>(<tt>Array</tt>)</span>
754
+
755
+
756
+
757
+ &mdash;
758
+ <div class='inline'>
759
+ <p>First item: parsed data; second item: raw body</p>
760
+ </div>
761
+
762
+ </li>
763
+
764
+ </ul>
765
+
766
+ </div><table class="source_code">
767
+ <tr>
768
+ <td>
769
+ <pre class="lines">
770
+
771
+
772
+ 21
773
+ 22
774
+ 23</pre>
775
+ </td>
776
+ <td>
777
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/location.rb', line 21</span>
778
+
779
+ <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>
780
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
781
+ <span class='kw'>end</span></pre>
782
+ </td>
783
+ </tr>
784
+ </table>
785
+ </div>
786
+
787
+ <div class="method_details ">
788
+ <h3 class="signature " id="update-instance_method">
789
+
790
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
791
+
792
+
793
+
794
+
795
+
796
+ </h3><div class="docstring">
797
+ <div class="discussion">
798
+
799
+ <p>First item: parsed data; second item: raw body</p>
800
+
801
+
802
+ </div>
803
+ </div>
804
+ <div class="tags">
805
+ <p class="tag_title">Parameters:</p>
806
+ <ul class="param">
807
+
808
+ <li>
809
+
810
+ <span class='name'>params</span>
811
+
812
+
813
+ <span class='type'>(<tt>Hash</tt>)</span>
814
+
815
+
816
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
817
+
818
+
819
+ &mdash;
820
+ <div class='inline'>
821
+ <p>a hash of params to be passed to the service</p>
822
+ </div>
823
+
824
+ </li>
825
+
826
+ <li>
827
+
828
+ <span class='name'>headers</span>
829
+
830
+
831
+ <span class='type'>(<tt>Hash</tt>)</span>
832
+
833
+
834
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
835
+
836
+
837
+ &mdash;
838
+ <div class='inline'>
839
+ <p>additional http headers</p>
840
+ </div>
841
+
842
+ </li>
843
+
844
+ </ul>
845
+
846
+
847
+
848
+
849
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
850
+ <ul class="option">
851
+
852
+ <li>
853
+ <span class="name">id</span>
854
+ <span class="type">(<tt>Object</tt>)</span>
855
+ <span class="default">
856
+
857
+ </span>
858
+
859
+ &mdash; <div class='inline'>
860
+ <p>Part of <tt>/api/locations/:id</tt> path</p>
861
+ </div>
862
+
863
+ </li>
864
+
865
+ <li>
866
+ <span class="name">locations</span>
867
+ <span class="type">(<tt>Hash</tt>)</span>
868
+ <span class="default">
869
+
870
+ </span>
871
+
872
+ &mdash; <div class='inline'>
873
+ <p>allowed keys are:</p>
874
+ <ul><li>
875
+ <p>:name [String]</p>
876
+ </li></ul>
877
+ </div>
878
+
879
+ </li>
880
+
881
+ </ul>
882
+
883
+
884
+
885
+
886
+ <p class="tag_title">Returns:</p>
887
+ <ul class="return">
888
+
889
+ <li>
890
+
891
+
892
+ <span class='type'>(<tt>Array</tt>)</span>
893
+
894
+
895
+
896
+ &mdash;
897
+ <div class='inline'>
898
+ <p>First item: parsed data; second item: raw body</p>
899
+ </div>
900
+
901
+ </li>
902
+
903
+ </ul>
904
+
905
+ </div><table class="source_code">
906
+ <tr>
907
+ <td>
908
+ <pre class="lines">
909
+
910
+
911
+ 44
912
+ 45
913
+ 46</pre>
914
+ </td>
915
+ <td>
916
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/location.rb', line 44</span>
917
+
918
+ <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>
919
+ <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</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>
920
+ <span class='kw'>end</span></pre>
921
+ </td>
922
+ </tr>
923
+ </table>
924
+ </div>
925
+
926
+ </div>
927
+
928
+ </div>
929
+
930
+ <div id="footer">
931
+ Generated on Thu Jun 20 12:05:21 2013 by
932
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
933
+ 0.8.3 (ruby-1.9.3).
934
+ </div>
935
+
936
+ </body>
937
+ </html>