katello_api 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. data/.gitignore +2 -0
  2. data/Gemfile +2 -0
  3. data/README.rdoc +0 -4
  4. data/doc/KatelloApi/Base.html +831 -0
  5. data/doc/KatelloApi/Generator/Base.html +671 -0
  6. data/doc/KatelloApi/Generator.html +115 -0
  7. data/doc/KatelloApi/Resources/ActivationKey.html +1757 -0
  8. data/doc/KatelloApi/Resources/Architecture.html +1007 -0
  9. data/doc/KatelloApi/Resources/Changeset.html +1413 -0
  10. data/doc/KatelloApi/Resources/ChangesetsContent.html +2674 -0
  11. data/doc/KatelloApi/Resources/ComputeResource.html +1067 -0
  12. data/doc/KatelloApi/Resources/ConfigTemplate.html +1361 -0
  13. data/doc/KatelloApi/Resources/ContentView.html +938 -0
  14. data/doc/KatelloApi/Resources/ContentViewDefinition.html +1629 -0
  15. data/doc/KatelloApi/Resources/Crl.html +367 -0
  16. data/doc/KatelloApi/Resources/Distribution.html +560 -0
  17. data/doc/KatelloApi/Resources/Distributor.html +1892 -0
  18. data/doc/KatelloApi/Resources/Domain.html +1066 -0
  19. data/doc/KatelloApi/Resources/Environment.html +1645 -0
  20. data/doc/KatelloApi/Resources/Erratum.html +632 -0
  21. data/doc/KatelloApi/Resources/GpgKey.html +1220 -0
  22. data/doc/KatelloApi/Resources/HardwareModel.html +1025 -0
  23. data/doc/KatelloApi/Resources/Organization.html +1062 -0
  24. data/doc/KatelloApi/Resources/Package.html +728 -0
  25. data/doc/KatelloApi/Resources/Permission.html +1021 -0
  26. data/doc/KatelloApi/Resources/Ping.html +625 -0
  27. data/doc/KatelloApi/Resources/Product.html +1845 -0
  28. data/doc/KatelloApi/Resources/Provider.html +2237 -0
  29. data/doc/KatelloApi/Resources/Repository.html +1976 -0
  30. data/doc/KatelloApi/Resources/RepositorySet.html +770 -0
  31. data/doc/KatelloApi/Resources/Role.html +1257 -0
  32. data/doc/KatelloApi/Resources/RoleLdapGroup.html +728 -0
  33. data/doc/KatelloApi/Resources/SmartProxy.html +1054 -0
  34. data/doc/KatelloApi/Resources/Statu.html +367 -0
  35. data/doc/KatelloApi/Resources/Subnet.html +1007 -0
  36. data/doc/KatelloApi/Resources/Subscription.html +1064 -0
  37. data/doc/KatelloApi/Resources/Sync.html +826 -0
  38. data/doc/KatelloApi/Resources/SyncPlan.html +1148 -0
  39. data/doc/KatelloApi/Resources/System.html +3576 -0
  40. data/doc/KatelloApi/Resources/SystemGroup.html +2006 -0
  41. data/doc/KatelloApi/Resources/SystemGroupErratum.html +602 -0
  42. data/doc/KatelloApi/Resources/SystemGroupPackage.html +826 -0
  43. data/doc/KatelloApi/Resources/SystemPackage.html +770 -0
  44. data/doc/KatelloApi/Resources/Task.html +546 -0
  45. data/doc/KatelloApi/Resources/Template.html +1573 -0
  46. data/doc/KatelloApi/Resources/TemplatesContent.html +2268 -0
  47. data/doc/KatelloApi/Resources/Uebercert.html +406 -0
  48. data/doc/KatelloApi/Resources/User.html +1846 -0
  49. data/doc/KatelloApi/Resources.html +117 -0
  50. data/doc/KatelloApi.html +365 -0
  51. data/doc/_index.html +539 -0
  52. data/doc/class_list.html +53 -0
  53. data/doc/css/common.css +1 -0
  54. data/doc/css/full_list.css +57 -0
  55. data/doc/css/style.css +338 -0
  56. data/doc/file.README.html +127 -0
  57. data/doc/file_list.html +55 -0
  58. data/doc/frames.html +28 -0
  59. data/doc/index.html +127 -0
  60. data/doc/js/app.js +214 -0
  61. data/doc/js/full_list.js +173 -0
  62. data/doc/js/jquery.js +4 -0
  63. data/doc/method_list.html +2548 -0
  64. data/doc/top-level-namespace.html +112 -0
  65. data/lib/katello_api/base.rb +61 -6
  66. data/lib/katello_api/documentation.json +1 -0
  67. data/lib/katello_api/resources/activation_key.rb +51 -48
  68. data/lib/katello_api/resources/architecture.rb +19 -24
  69. data/lib/katello_api/resources/changeset.rb +39 -37
  70. data/lib/katello_api/resources/changesets_content.rb +64 -57
  71. data/lib/katello_api/resources/compute_resource.rb +37 -42
  72. data/lib/katello_api/resources/config_template.rb +40 -44
  73. data/lib/katello_api/resources/content_view.rb +14 -17
  74. data/lib/katello_api/resources/content_view_definition.rb +34 -42
  75. data/lib/katello_api/resources/crl.rb +3 -4
  76. data/lib/katello_api/resources/distribution.rb +8 -8
  77. data/lib/katello_api/resources/distributor.rb +35 -37
  78. data/lib/katello_api/resources/domain.rb +28 -32
  79. data/lib/katello_api/resources/environment.rb +38 -44
  80. data/lib/katello_api/resources/erratum.rb +9 -8
  81. data/lib/katello_api/resources/gpg_key.rb +28 -33
  82. data/lib/katello_api/resources/hardware_model.rb +25 -30
  83. data/lib/katello_api/resources/organization.rb +24 -26
  84. data/lib/katello_api/resources/package.rb +9 -12
  85. data/lib/katello_api/resources/permission.rb +21 -19
  86. data/lib/katello_api/resources/ping.rb +9 -12
  87. data/lib/katello_api/resources/product.rb +34 -43
  88. data/lib/katello_api/resources/provider.rb +55 -66
  89. data/lib/katello_api/resources/repository.rb +44 -55
  90. data/lib/katello_api/resources/repository_set.rb +9 -12
  91. data/lib/katello_api/resources/role.rb +35 -33
  92. data/lib/katello_api/resources/role_ldap_group.rb +10 -12
  93. data/lib/katello_api/resources/smart_proxy.rb +24 -28
  94. data/lib/katello_api/resources/statu.rb +3 -4
  95. data/lib/katello_api/resources/subnet.rb +19 -24
  96. data/lib/katello_api/resources/subscription.rb +16 -21
  97. data/lib/katello_api/resources/sync.rb +9 -12
  98. data/lib/katello_api/resources/sync_plan.rb +28 -33
  99. data/lib/katello_api/resources/system.rb +81 -90
  100. data/lib/katello_api/resources/system_group.rb +47 -57
  101. data/lib/katello_api/resources/system_group_erratum.rb +6 -8
  102. data/lib/katello_api/resources/system_group_package.rb +15 -18
  103. data/lib/katello_api/resources/system_package.rb +12 -15
  104. data/lib/katello_api/resources/task.rb +6 -8
  105. data/lib/katello_api/resources/template.rb +39 -47
  106. data/lib/katello_api/resources/templates_content.rb +40 -52
  107. data/lib/katello_api/resources/uebercert.rb +4 -4
  108. data/lib/katello_api/resources/user.rb +47 -50
  109. data/lib/katello_api/version.rb +1 -1
  110. data/lib/katello_api.rb +0 -13
  111. metadata +68 -4
data/doc/KatelloApi/Resources/Domain.html ADDED
@@ -0,0 +1,1066 @@
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: KatelloApi::Resources::Domain
8
+
9
+ &mdash; Documentation by YARD 0.8.5.2
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 (D)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../KatelloApi.html" title="KatelloApi (module)">KatelloApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resources.html" title="KatelloApi::Resources (module)">Resources</a></span></span>
36
+ &raquo;
37
+ <span class="title">Domain</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: KatelloApi::Resources::Domain
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"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></li>
82
+
83
+ <li class="next">KatelloApi::Resources::Domain</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/katello_api/resources/domain.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+ <h2>Constant Summary</h2>
106
+
107
+
108
+
109
+
110
+ <h2>Constant Summary</h2>
111
+
112
+ <h3 class="inherited">Constants inherited
113
+ from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
114
+ <p class="inherited"><span class='object_link'><a href="../Base.html#API_VERSION-constant" title="KatelloApi::Base::API_VERSION (constant)">Base::API_VERSION</a></span></p>
115
+
116
+
117
+
118
+
119
+ <h2>Instance Attribute Summary</h2>
120
+
121
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
122
+ <p class="inherited"><span class='object_link'><a href="../Base.html#client-instance_method" title="KatelloApi::Base#client (method)">#client</a></span>, <span class='object_link'><a href="../Base.html#config-instance_method" title="KatelloApi::Base#config (method)">#config</a></span></p>
123
+
124
+
125
+
126
+ <h2>
127
+ Class Method Summary
128
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
129
+ </h2>
130
+
131
+ <ul class="summary">
132
+
133
+ <li class="public ">
134
+ <span class="summary_signature">
135
+
136
+ <a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
137
+
138
+
139
+
140
+ </span>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'></div></span>
151
+
152
+ </li>
153
+
154
+
155
+ </ul>
156
+
157
+ <h2>
158
+ Instance Method Summary
159
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'><p>
182
+ First item: parsed data; second item: raw body.
183
+ </p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'><p>
207
+ First item: parsed data; second item: raw body.
208
+ </p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'><p>
232
+ First item: parsed data; second item: raw body.
233
+ </p>
234
+ </div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
243
+
244
+
245
+
246
+ </span>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+ <span class="summary_desc"><div class='inline'><p>
257
+ First item: parsed data; second item: raw body.
258
+ </p>
259
+ </div></span>
260
+
261
+ </li>
262
+
263
+
264
+ <li class="public ">
265
+ <span class="summary_signature">
266
+
267
+ <a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
268
+
269
+
270
+
271
+ </span>
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+ <span class="summary_desc"><div class='inline'><p>
282
+ First item: parsed data; second item: raw body.
283
+ </p>
284
+ </div></span>
285
+
286
+ </li>
287
+
288
+
289
+ </ul>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
302
+ <p class="inherited"><span class='object_link'><a href="../Base.html#http_call-instance_method" title="KatelloApi::Base#http_call (method)">#http_call</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Base.html#method_doc-class_method" title="KatelloApi::Base.method_doc (method)">method_doc</a></span>, <span class='object_link'><a href="../Base.html#perform_call-instance_method" title="KatelloApi::Base#perform_call (method)">#perform_call</a></span>, <span class='object_link'><a href="../Base.html#validate_params%21-instance_method" title="KatelloApi::Base#validate_params! (method)">#validate_params!</a></span>, <span class='object_link'><a href="../Base.html#validation_hash-class_method" title="KatelloApi::Base.validation_hash (method)">validation_hash</a></span></p>
303
+ <div id="constructor_details" class="method_details_list">
304
+ <h2>Constructor Details</h2>
305
+
306
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">KatelloApi::Base</a></span></p>
307
+
308
+ </div>
309
+
310
+
311
+ <div id="class_method_details" class="method_details_list">
312
+ <h2>Class Method Details</h2>
313
+
314
+
315
+ <div class="method_details first">
316
+ <h3 class="signature first" id="doc-class_method">
317
+
318
+ + (<tt>Object</tt>) <strong>doc</strong>
319
+
320
+
321
+
322
+
323
+
324
+ </h3><table class="source_code">
325
+ <tr>
326
+ <td>
327
+ <pre class="lines">
328
+
329
+
330
+ 4
331
+ 5
332
+ 6</pre>
333
+ </td>
334
+ <td>
335
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/domain.rb', line 4</span>
336
+
337
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
338
+ <span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_KatelloApi constant id'>KatelloApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>&quot;domains&quot;</span><span class='rbrack token'>]</span>
339
+ <span class='rubyid_end end kw'>end</span>
340
+ </pre>
341
+ </td>
342
+ </tr>
343
+ </table>
344
+ </div>
345
+
346
+ </div>
347
+
348
+ <div id="instance_method_details" class="method_details_list">
349
+ <h2>Instance Method Details</h2>
350
+
351
+
352
+ <div class="method_details first">
353
+ <h3 class="signature first" id="create-instance_method">
354
+
355
+ - (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
356
+
357
+
358
+
359
+
360
+
361
+ </h3><div class="docstring">
362
+ <div class="discussion">
363
+ <p>
364
+ First item: parsed data; second item: raw body
365
+ </p>
366
+
367
+
368
+ </div>
369
+ </div>
370
+ <div class="tags">
371
+ <p class="tag_title">Parameters:</p>
372
+ <ul class="param">
373
+
374
+ <li>
375
+
376
+ <span class='name'>params</span>
377
+
378
+
379
+ <span class='type'>(<tt>Hash</tt>)</span>
380
+
381
+
382
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
383
+
384
+
385
+ &mdash;
386
+ <div class='inline'><p>
387
+ a hash of params to be passed to the service
388
+ </p>
389
+ </div>
390
+
391
+ </li>
392
+
393
+ <li>
394
+
395
+ <span class='name'>headers</span>
396
+
397
+
398
+ <span class='type'>(<tt>Hash</tt>)</span>
399
+
400
+
401
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
402
+
403
+
404
+ &mdash;
405
+ <div class='inline'><p>
406
+ additional http headers
407
+ </p>
408
+ </div>
409
+
410
+ </li>
411
+
412
+ </ul>
413
+
414
+
415
+
416
+
417
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
418
+ <ul class="option">
419
+
420
+ <li>
421
+ <span class="name">domain</span>
422
+ <span class="type">(<tt>Hash</tt>)</span>
423
+ <span class="default">
424
+
425
+ </span>
426
+
427
+ &mdash; <div class='inline'><p>
428
+ allowed keys are:
429
+ </p>
430
+ <ul>
431
+ <li>dns_id [String, nil] dns proxy to use within this domain
432
+
433
+ </li>
434
+ <li>domain_parameters_attributes [String, nil] array of parameters (name,
435
+ value)
436
+
437
+ </li>
438
+ <li>fullname [String, nil] full name describing the domain
439
+
440
+ </li>
441
+ <li>name [String] the full dns domain name
442
+
443
+ </li>
444
+ </ul>
445
+ </div>
446
+
447
+ </li>
448
+
449
+ </ul>
450
+
451
+
452
+
453
+
454
+ <p class="tag_title">Returns:</p>
455
+ <ul class="return">
456
+
457
+ <li>
458
+
459
+
460
+ <span class='type'>(<tt>Array</tt>)</span>
461
+
462
+
463
+
464
+ &mdash;
465
+ <div class='inline'><p>
466
+ First item: parsed data; second item: raw body
467
+ </p>
468
+ </div>
469
+
470
+ </li>
471
+
472
+ </ul>
473
+
474
+ </div><table class="source_code">
475
+ <tr>
476
+ <td>
477
+ <pre class="lines">
478
+
479
+
480
+ 37
481
+ 38
482
+ 39</pre>
483
+ </td>
484
+ <td>
485
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/domain.rb', line 37</span>
486
+
487
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
488
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
489
+ <span class='rubyid_end end kw'>end</span>
490
+ </pre>
491
+ </td>
492
+ </tr>
493
+ </table>
494
+ </div>
495
+
496
+ <div class="method_details ">
497
+ <h3 class="signature " id="destroy-instance_method">
498
+
499
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
500
+
501
+
502
+
503
+
504
+
505
+ </h3><div class="docstring">
506
+ <div class="discussion">
507
+ <p>
508
+ First item: parsed data; second item: raw body
509
+ </p>
510
+
511
+
512
+ </div>
513
+ </div>
514
+ <div class="tags">
515
+ <p class="tag_title">Parameters:</p>
516
+ <ul class="param">
517
+
518
+ <li>
519
+
520
+ <span class='name'>params</span>
521
+
522
+
523
+ <span class='type'>(<tt>Hash</tt>)</span>
524
+
525
+
526
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
527
+
528
+
529
+ &mdash;
530
+ <div class='inline'><p>
531
+ a hash of params to be passed to the service
532
+ </p>
533
+ </div>
534
+
535
+ </li>
536
+
537
+ <li>
538
+
539
+ <span class='name'>headers</span>
540
+
541
+
542
+ <span class='type'>(<tt>Hash</tt>)</span>
543
+
544
+
545
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
546
+
547
+
548
+ &mdash;
549
+ <div class='inline'><p>
550
+ additional http headers
551
+ </p>
552
+ </div>
553
+
554
+ </li>
555
+
556
+ </ul>
557
+
558
+
559
+
560
+
561
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
562
+ <ul class="option">
563
+
564
+ <li>
565
+ <span class="name">id</span>
566
+ <span class="type">(<tt>String</tt>)</span>
567
+ <span class="default">
568
+
569
+ </span>
570
+
571
+ &mdash; <div class='inline'><p>
572
+ domain name (no slashes)
573
+ </p>
574
+ </div>
575
+
576
+ </li>
577
+
578
+ </ul>
579
+
580
+
581
+
582
+
583
+ <p class="tag_title">Returns:</p>
584
+ <ul class="return">
585
+
586
+ <li>
587
+
588
+
589
+ <span class='type'>(<tt>Array</tt>)</span>
590
+
591
+
592
+
593
+ &mdash;
594
+ <div class='inline'><p>
595
+ First item: parsed data; second item: raw body
596
+ </p>
597
+ </div>
598
+
599
+ </li>
600
+
601
+ </ul>
602
+
603
+ </div><table class="source_code">
604
+ <tr>
605
+ <td>
606
+ <pre class="lines">
607
+
608
+
609
+ 61
610
+ 62
611
+ 63</pre>
612
+ </td>
613
+ <td>
614
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/domain.rb', line 61</span>
615
+
616
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
617
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
618
+ <span class='rubyid_end end kw'>end</span>
619
+ </pre>
620
+ </td>
621
+ </tr>
622
+ </table>
623
+ </div>
624
+
625
+ <div class="method_details ">
626
+ <h3 class="signature " id="index-instance_method">
627
+
628
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
629
+
630
+
631
+
632
+
633
+
634
+ </h3><div class="docstring">
635
+ <div class="discussion">
636
+ <p>
637
+ First item: parsed data; second item: raw body
638
+ </p>
639
+
640
+
641
+ </div>
642
+ </div>
643
+ <div class="tags">
644
+ <p class="tag_title">Parameters:</p>
645
+ <ul class="param">
646
+
647
+ <li>
648
+
649
+ <span class='name'>params</span>
650
+
651
+
652
+ <span class='type'>(<tt>Hash</tt>)</span>
653
+
654
+
655
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
656
+
657
+
658
+ &mdash;
659
+ <div class='inline'><p>
660
+ a hash of params to be passed to the service
661
+ </p>
662
+ </div>
663
+
664
+ </li>
665
+
666
+ <li>
667
+
668
+ <span class='name'>headers</span>
669
+
670
+
671
+ <span class='type'>(<tt>Hash</tt>)</span>
672
+
673
+
674
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
675
+
676
+
677
+ &mdash;
678
+ <div class='inline'><p>
679
+ additional http headers
680
+ </p>
681
+ </div>
682
+
683
+ </li>
684
+
685
+ </ul>
686
+
687
+
688
+
689
+
690
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
691
+ <ul class="option">
692
+
693
+ <li>
694
+ <span class="name">order</span>
695
+ <span class="type">(<tt>String</tt>)</span>
696
+ <span class="default">
697
+
698
+ </span>
699
+
700
+ &mdash; <div class='inline'><p>
701
+ sort results
702
+ </p>
703
+ </div>
704
+
705
+ </li>
706
+
707
+ <li>
708
+ <span class="name">search</span>
709
+ <span class="type">(<tt>String</tt>)</span>
710
+ <span class="default">
711
+
712
+ </span>
713
+
714
+ &mdash; <div class='inline'><p>
715
+ filter results
716
+ </p>
717
+ </div>
718
+
719
+ </li>
720
+
721
+ </ul>
722
+
723
+
724
+
725
+
726
+ <p class="tag_title">Returns:</p>
727
+ <ul class="return">
728
+
729
+ <li>
730
+
731
+
732
+ <span class='type'>(<tt>Array</tt>)</span>
733
+
734
+
735
+
736
+ &mdash;
737
+ <div class='inline'><p>
738
+ First item: parsed data; second item: raw body
739
+ </p>
740
+ </div>
741
+
742
+ </li>
743
+
744
+ </ul>
745
+
746
+ </div><table class="source_code">
747
+ <tr>
748
+ <td>
749
+ <pre class="lines">
750
+
751
+
752
+ 14
753
+ 15
754
+ 16</pre>
755
+ </td>
756
+ <td>
757
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/domain.rb', line 14</span>
758
+
759
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
760
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
761
+ <span class='rubyid_end end kw'>end</span>
762
+ </pre>
763
+ </td>
764
+ </tr>
765
+ </table>
766
+ </div>
767
+
768
+ <div class="method_details ">
769
+ <h3 class="signature " id="show-instance_method">
770
+
771
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
772
+
773
+
774
+
775
+
776
+
777
+ </h3><div class="docstring">
778
+ <div class="discussion">
779
+ <p>
780
+ First item: parsed data; second item: raw body
781
+ </p>
782
+
783
+
784
+ </div>
785
+ </div>
786
+ <div class="tags">
787
+ <p class="tag_title">Parameters:</p>
788
+ <ul class="param">
789
+
790
+ <li>
791
+
792
+ <span class='name'>params</span>
793
+
794
+
795
+ <span class='type'>(<tt>Hash</tt>)</span>
796
+
797
+
798
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
799
+
800
+
801
+ &mdash;
802
+ <div class='inline'><p>
803
+ a hash of params to be passed to the service
804
+ </p>
805
+ </div>
806
+
807
+ </li>
808
+
809
+ <li>
810
+
811
+ <span class='name'>headers</span>
812
+
813
+
814
+ <span class='type'>(<tt>Hash</tt>)</span>
815
+
816
+
817
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
818
+
819
+
820
+ &mdash;
821
+ <div class='inline'><p>
822
+ additional http headers
823
+ </p>
824
+ </div>
825
+
826
+ </li>
827
+
828
+ </ul>
829
+
830
+
831
+
832
+
833
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
834
+ <ul class="option">
835
+
836
+ <li>
837
+ <span class="name">id</span>
838
+ <span class="type">(<tt>String</tt>)</span>
839
+ <span class="default">
840
+
841
+ </span>
842
+
843
+ &mdash; <div class='inline'><p>
844
+ domain name (no slashes)
845
+ </p>
846
+ </div>
847
+
848
+ </li>
849
+
850
+ </ul>
851
+
852
+
853
+
854
+
855
+ <p class="tag_title">Returns:</p>
856
+ <ul class="return">
857
+
858
+ <li>
859
+
860
+
861
+ <span class='type'>(<tt>Array</tt>)</span>
862
+
863
+
864
+
865
+ &mdash;
866
+ <div class='inline'><p>
867
+ First item: parsed data; second item: raw body
868
+ </p>
869
+ </div>
870
+
871
+ </li>
872
+
873
+ </ul>
874
+
875
+ </div><table class="source_code">
876
+ <tr>
877
+ <td>
878
+ <pre class="lines">
879
+
880
+
881
+ 23
882
+ 24
883
+ 25</pre>
884
+ </td>
885
+ <td>
886
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/domain.rb', line 23</span>
887
+
888
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
889
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
890
+ <span class='rubyid_end end kw'>end</span>
891
+ </pre>
892
+ </td>
893
+ </tr>
894
+ </table>
895
+ </div>
896
+
897
+ <div class="method_details ">
898
+ <h3 class="signature " id="update-instance_method">
899
+
900
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
901
+
902
+
903
+
904
+
905
+
906
+ </h3><div class="docstring">
907
+ <div class="discussion">
908
+ <p>
909
+ First item: parsed data; second item: raw body
910
+ </p>
911
+
912
+
913
+ </div>
914
+ </div>
915
+ <div class="tags">
916
+ <p class="tag_title">Parameters:</p>
917
+ <ul class="param">
918
+
919
+ <li>
920
+
921
+ <span class='name'>params</span>
922
+
923
+
924
+ <span class='type'>(<tt>Hash</tt>)</span>
925
+
926
+
927
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
928
+
929
+
930
+ &mdash;
931
+ <div class='inline'><p>
932
+ a hash of params to be passed to the service
933
+ </p>
934
+ </div>
935
+
936
+ </li>
937
+
938
+ <li>
939
+
940
+ <span class='name'>headers</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'><p>
951
+ additional http headers
952
+ </p>
953
+ </div>
954
+
955
+ </li>
956
+
957
+ </ul>
958
+
959
+
960
+
961
+
962
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
963
+ <ul class="option">
964
+
965
+ <li>
966
+ <span class="name">id</span>
967
+ <span class="type">(<tt>Object</tt>)</span>
968
+ <span class="default">
969
+
970
+ </span>
971
+
972
+ &mdash; <div class='inline'><p>
973
+ Part of <tt>/api/domains/:id</tt> path
974
+ </p>
975
+ </div>
976
+
977
+ </li>
978
+
979
+ <li>
980
+ <span class="name">domain</span>
981
+ <span class="type">(<tt>Hash</tt>)</span>
982
+ <span class="default">
983
+
984
+ </span>
985
+
986
+ &mdash; <div class='inline'><p>
987
+ allowed keys are:
988
+ </p>
989
+ <ul>
990
+ <li>dns_id [String, nil] dns proxy to use within this domain
991
+
992
+ </li>
993
+ <li>domain_parameters_attributes [String, nil] array of parameters (name,
994
+ value)
995
+
996
+ </li>
997
+ <li>fullname [String, nil] full name describing the domain
998
+
999
+ </li>
1000
+ <li>name [String] the full dns domain name
1001
+
1002
+ </li>
1003
+ </ul>
1004
+ </div>
1005
+
1006
+ </li>
1007
+
1008
+ </ul>
1009
+
1010
+
1011
+
1012
+
1013
+ <p class="tag_title">Returns:</p>
1014
+ <ul class="return">
1015
+
1016
+ <li>
1017
+
1018
+
1019
+ <span class='type'>(<tt>Array</tt>)</span>
1020
+
1021
+
1022
+
1023
+ &mdash;
1024
+ <div class='inline'><p>
1025
+ First item: parsed data; second item: raw body
1026
+ </p>
1027
+ </div>
1028
+
1029
+ </li>
1030
+
1031
+ </ul>
1032
+
1033
+ </div><table class="source_code">
1034
+ <tr>
1035
+ <td>
1036
+ <pre class="lines">
1037
+
1038
+
1039
+ 52
1040
+ 53
1041
+ 54</pre>
1042
+ </td>
1043
+ <td>
1044
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/domain.rb', line 52</span>
1045
+
1046
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
1047
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
1048
+ <span class='rubyid_end end kw'>end</span>
1049
+ </pre>
1050
+ </td>
1051
+ </tr>
1052
+ </table>
1053
+ </div>
1054
+
1055
+ </div>
1056
+
1057
+ </div>
1058
+
1059
+ <div id="footer">
1060
+ Generated on Mon Mar 18 14:17:42 2013 by
1061
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1062
+ 0.8.5.2 (ruby-1.8.7).
1063
+ </div>
1064
+
1065
+ </body>
1066
+ </html>