katello_api 0.0.1 → 0.0.2

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 (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/Role.html ADDED
@@ -0,0 +1,1257 @@
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::Role
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 (R)</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">Role</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::Role
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::Role</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/role.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="#available_verbs-instance_method" title="#available_verbs (instance method)">- (Array) <strong>available_verbs</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="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</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="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</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="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</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="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</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
+ <li class="public ">
290
+ <span class="summary_signature">
291
+
292
+ <a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
293
+
294
+
295
+
296
+ </span>
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+ <span class="summary_desc"><div class='inline'><p>
307
+ First item: parsed data; second item: raw body.
308
+ </p>
309
+ </div></span>
310
+
311
+ </li>
312
+
313
+
314
+ </ul>
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
327
+ <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>
328
+ <div id="constructor_details" class="method_details_list">
329
+ <h2>Constructor Details</h2>
330
+
331
+ <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>
332
+
333
+ </div>
334
+
335
+
336
+ <div id="class_method_details" class="method_details_list">
337
+ <h2>Class Method Details</h2>
338
+
339
+
340
+ <div class="method_details first">
341
+ <h3 class="signature first" id="doc-class_method">
342
+
343
+ + (<tt>Object</tt>) <strong>doc</strong>
344
+
345
+
346
+
347
+
348
+
349
+ </h3><table class="source_code">
350
+ <tr>
351
+ <td>
352
+ <pre class="lines">
353
+
354
+
355
+ 4
356
+ 5
357
+ 6</pre>
358
+ </td>
359
+ <td>
360
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/role.rb', line 4</span>
361
+
362
+ <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>
363
+ <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;roles&quot;</span><span class='rbrack token'>]</span>
364
+ <span class='rubyid_end end kw'>end</span>
365
+ </pre>
366
+ </td>
367
+ </tr>
368
+ </table>
369
+ </div>
370
+
371
+ </div>
372
+
373
+ <div id="instance_method_details" class="method_details_list">
374
+ <h2>Instance Method Details</h2>
375
+
376
+
377
+ <div class="method_details first">
378
+ <h3 class="signature first" id="available_verbs-instance_method">
379
+
380
+ - (<tt>Array</tt>) <strong>available_verbs</strong>(params = {}, headers = {})
381
+
382
+
383
+
384
+
385
+
386
+ </h3><div class="docstring">
387
+ <div class="discussion">
388
+ <p>
389
+ First item: parsed data; second item: raw body
390
+ </p>
391
+
392
+
393
+ </div>
394
+ </div>
395
+ <div class="tags">
396
+ <p class="tag_title">Parameters:</p>
397
+ <ul class="param">
398
+
399
+ <li>
400
+
401
+ <span class='name'>params</span>
402
+
403
+
404
+ <span class='type'>(<tt>Hash</tt>)</span>
405
+
406
+
407
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
408
+
409
+
410
+ &mdash;
411
+ <div class='inline'><p>
412
+ a hash of params to be passed to the service
413
+ </p>
414
+ </div>
415
+
416
+ </li>
417
+
418
+ <li>
419
+
420
+ <span class='name'>headers</span>
421
+
422
+
423
+ <span class='type'>(<tt>Hash</tt>)</span>
424
+
425
+
426
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
427
+
428
+
429
+ &mdash;
430
+ <div class='inline'><p>
431
+ additional http headers
432
+ </p>
433
+ </div>
434
+
435
+ </li>
436
+
437
+ </ul>
438
+
439
+
440
+
441
+
442
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
443
+ <ul class="option">
444
+
445
+ <li>
446
+ <span class="name">organization_id</span>
447
+ <span class="type">(<tt>String</tt>)</span>
448
+ <span class="default">
449
+
450
+ </span>
451
+
452
+ &mdash; <div class='inline'><p>
453
+ with this option specified the listed tags are scoped to the organization.
454
+ </p>
455
+ </div>
456
+
457
+ </li>
458
+
459
+ </ul>
460
+
461
+
462
+
463
+
464
+ <p class="tag_title">Returns:</p>
465
+ <ul class="return">
466
+
467
+ <li>
468
+
469
+
470
+ <span class='type'>(<tt>Array</tt>)</span>
471
+
472
+
473
+
474
+ &mdash;
475
+ <div class='inline'><p>
476
+ First item: parsed data; second item: raw body
477
+ </p>
478
+ </div>
479
+
480
+ </li>
481
+
482
+ </ul>
483
+
484
+ </div><table class="source_code">
485
+ <tr>
486
+ <td>
487
+ <pre class="lines">
488
+
489
+
490
+ 70
491
+ 71
492
+ 72</pre>
493
+ </td>
494
+ <td>
495
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/role.rb', line 70</span>
496
+
497
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_available_verbs identifier id'>available_verbs</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>
498
+ <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>
499
+ <span class='rubyid_end end kw'>end</span>
500
+ </pre>
501
+ </td>
502
+ </tr>
503
+ </table>
504
+ </div>
505
+
506
+ <div class="method_details ">
507
+ <h3 class="signature " id="create-instance_method">
508
+
509
+ - (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
510
+
511
+
512
+
513
+
514
+
515
+ </h3><div class="docstring">
516
+ <div class="discussion">
517
+ <p>
518
+ First item: parsed data; second item: raw body
519
+ </p>
520
+
521
+
522
+ </div>
523
+ </div>
524
+ <div class="tags">
525
+ <p class="tag_title">Parameters:</p>
526
+ <ul class="param">
527
+
528
+ <li>
529
+
530
+ <span class='name'>params</span>
531
+
532
+
533
+ <span class='type'>(<tt>Hash</tt>)</span>
534
+
535
+
536
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
537
+
538
+
539
+ &mdash;
540
+ <div class='inline'><p>
541
+ a hash of params to be passed to the service
542
+ </p>
543
+ </div>
544
+
545
+ </li>
546
+
547
+ <li>
548
+
549
+ <span class='name'>headers</span>
550
+
551
+
552
+ <span class='type'>(<tt>Hash</tt>)</span>
553
+
554
+
555
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
556
+
557
+
558
+ &mdash;
559
+ <div class='inline'><p>
560
+ additional http headers
561
+ </p>
562
+ </div>
563
+
564
+ </li>
565
+
566
+ </ul>
567
+
568
+
569
+
570
+
571
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
572
+ <ul class="option">
573
+
574
+ <li>
575
+ <span class="name">user_id</span>
576
+ <span class="type">(<tt>Object</tt>)</span>
577
+ <span class="default">
578
+
579
+ </span>
580
+
581
+ &mdash; <div class='inline'><p>
582
+ Part of <tt>/api/users/:user_id/roles</tt> path
583
+ </p>
584
+ </div>
585
+
586
+ </li>
587
+
588
+ <li>
589
+ <span class="name">role</span>
590
+ <span class="type">(<tt>Hash</tt>)</span>
591
+ <span class="default">
592
+
593
+ </span>
594
+
595
+ &mdash; <div class='inline'><p>
596
+ allowed keys are:
597
+ </p>
598
+ <ul>
599
+ <li>description [String, nil]
600
+
601
+ </li>
602
+ <li>name [String]
603
+
604
+ </li>
605
+ </ul>
606
+ </div>
607
+
608
+ </li>
609
+
610
+ </ul>
611
+
612
+
613
+
614
+
615
+ <p class="tag_title">Returns:</p>
616
+ <ul class="return">
617
+
618
+ <li>
619
+
620
+
621
+ <span class='type'>(<tt>Array</tt>)</span>
622
+
623
+
624
+
625
+ &mdash;
626
+ <div class='inline'><p>
627
+ First item: parsed data; second item: raw body
628
+ </p>
629
+ </div>
630
+
631
+ </li>
632
+
633
+ </ul>
634
+
635
+ </div><table class="source_code">
636
+ <tr>
637
+ <td>
638
+ <pre class="lines">
639
+
640
+
641
+ 37
642
+ 38
643
+ 39</pre>
644
+ </td>
645
+ <td>
646
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/role.rb', line 37</span>
647
+
648
+ <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>
649
+ <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>
650
+ <span class='rubyid_end end kw'>end</span>
651
+ </pre>
652
+ </td>
653
+ </tr>
654
+ </table>
655
+ </div>
656
+
657
+ <div class="method_details ">
658
+ <h3 class="signature " id="destroy-instance_method">
659
+
660
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
661
+
662
+
663
+
664
+
665
+
666
+ </h3><div class="docstring">
667
+ <div class="discussion">
668
+ <p>
669
+ First item: parsed data; second item: raw body
670
+ </p>
671
+
672
+
673
+ </div>
674
+ </div>
675
+ <div class="tags">
676
+ <p class="tag_title">Parameters:</p>
677
+ <ul class="param">
678
+
679
+ <li>
680
+
681
+ <span class='name'>params</span>
682
+
683
+
684
+ <span class='type'>(<tt>Hash</tt>)</span>
685
+
686
+
687
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
688
+
689
+
690
+ &mdash;
691
+ <div class='inline'><p>
692
+ a hash of params to be passed to the service
693
+ </p>
694
+ </div>
695
+
696
+ </li>
697
+
698
+ <li>
699
+
700
+ <span class='name'>headers</span>
701
+
702
+
703
+ <span class='type'>(<tt>Hash</tt>)</span>
704
+
705
+
706
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
707
+
708
+
709
+ &mdash;
710
+ <div class='inline'><p>
711
+ additional http headers
712
+ </p>
713
+ </div>
714
+
715
+ </li>
716
+
717
+ </ul>
718
+
719
+
720
+
721
+
722
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
723
+ <ul class="option">
724
+
725
+ <li>
726
+ <span class="name">id</span>
727
+ <span class="type">(<tt>Object</tt>)</span>
728
+ <span class="default">
729
+
730
+ </span>
731
+
732
+ &mdash; <div class='inline'><p>
733
+ Part of <tt>/api/roles/:id</tt> path
734
+ </p>
735
+ </div>
736
+
737
+ </li>
738
+
739
+ <li>
740
+ <span class="name">user_id</span>
741
+ <span class="type">(<tt>Object</tt>)</span>
742
+ <span class="default">
743
+
744
+ </span>
745
+
746
+ &mdash; <div class='inline'><p>
747
+ Part of <tt>/api/users/:user_id/roles/:id</tt> path
748
+ </p>
749
+ </div>
750
+
751
+ </li>
752
+
753
+ </ul>
754
+
755
+
756
+
757
+
758
+ <p class="tag_title">Returns:</p>
759
+ <ul class="return">
760
+
761
+ <li>
762
+
763
+
764
+ <span class='type'>(<tt>Array</tt>)</span>
765
+
766
+
767
+
768
+ &mdash;
769
+ <div class='inline'><p>
770
+ First item: parsed data; second item: raw body
771
+ </p>
772
+ </div>
773
+
774
+ </li>
775
+
776
+ </ul>
777
+
778
+ </div><table class="source_code">
779
+ <tr>
780
+ <td>
781
+ <pre class="lines">
782
+
783
+
784
+ 61
785
+ 62
786
+ 63</pre>
787
+ </td>
788
+ <td>
789
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/role.rb', line 61</span>
790
+
791
+ <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>
792
+ <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>
793
+ <span class='rubyid_end end kw'>end</span>
794
+ </pre>
795
+ </td>
796
+ </tr>
797
+ </table>
798
+ </div>
799
+
800
+ <div class="method_details ">
801
+ <h3 class="signature " id="index-instance_method">
802
+
803
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
804
+
805
+
806
+
807
+
808
+
809
+ </h3><div class="docstring">
810
+ <div class="discussion">
811
+ <p>
812
+ First item: parsed data; second item: raw body
813
+ </p>
814
+
815
+
816
+ </div>
817
+ </div>
818
+ <div class="tags">
819
+ <p class="tag_title">Parameters:</p>
820
+ <ul class="param">
821
+
822
+ <li>
823
+
824
+ <span class='name'>params</span>
825
+
826
+
827
+ <span class='type'>(<tt>Hash</tt>)</span>
828
+
829
+
830
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
831
+
832
+
833
+ &mdash;
834
+ <div class='inline'><p>
835
+ a hash of params to be passed to the service
836
+ </p>
837
+ </div>
838
+
839
+ </li>
840
+
841
+ <li>
842
+
843
+ <span class='name'>headers</span>
844
+
845
+
846
+ <span class='type'>(<tt>Hash</tt>)</span>
847
+
848
+
849
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
850
+
851
+
852
+ &mdash;
853
+ <div class='inline'><p>
854
+ additional http headers
855
+ </p>
856
+ </div>
857
+
858
+ </li>
859
+
860
+ </ul>
861
+
862
+
863
+
864
+
865
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
866
+ <ul class="option">
867
+
868
+ <li>
869
+ <span class="name">user_id</span>
870
+ <span class="type">(<tt>Object</tt>)</span>
871
+ <span class="default">
872
+
873
+ </span>
874
+
875
+ &mdash; <div class='inline'><p>
876
+ Part of <tt>/api/users/:user_id/roles</tt> path
877
+ </p>
878
+ </div>
879
+
880
+ </li>
881
+
882
+ <li>
883
+ <span class="name">name</span>
884
+ <span class="type">(<tt>String</tt>)</span>
885
+ <span class="default">
886
+
887
+ </span>
888
+
889
+ </li>
890
+
891
+ </ul>
892
+
893
+
894
+
895
+
896
+ <p class="tag_title">Returns:</p>
897
+ <ul class="return">
898
+
899
+ <li>
900
+
901
+
902
+ <span class='type'>(<tt>Array</tt>)</span>
903
+
904
+
905
+
906
+ &mdash;
907
+ <div class='inline'><p>
908
+ First item: parsed data; second item: raw body
909
+ </p>
910
+ </div>
911
+
912
+ </li>
913
+
914
+ </ul>
915
+
916
+ </div><table class="source_code">
917
+ <tr>
918
+ <td>
919
+ <pre class="lines">
920
+
921
+
922
+ 14
923
+ 15
924
+ 16</pre>
925
+ </td>
926
+ <td>
927
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/role.rb', line 14</span>
928
+
929
+ <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>
930
+ <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>
931
+ <span class='rubyid_end end kw'>end</span>
932
+ </pre>
933
+ </td>
934
+ </tr>
935
+ </table>
936
+ </div>
937
+
938
+ <div class="method_details ">
939
+ <h3 class="signature " id="show-instance_method">
940
+
941
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
942
+
943
+
944
+
945
+
946
+
947
+ </h3><div class="docstring">
948
+ <div class="discussion">
949
+ <p>
950
+ First item: parsed data; second item: raw body
951
+ </p>
952
+
953
+
954
+ </div>
955
+ </div>
956
+ <div class="tags">
957
+ <p class="tag_title">Parameters:</p>
958
+ <ul class="param">
959
+
960
+ <li>
961
+
962
+ <span class='name'>params</span>
963
+
964
+
965
+ <span class='type'>(<tt>Hash</tt>)</span>
966
+
967
+
968
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
969
+
970
+
971
+ &mdash;
972
+ <div class='inline'><p>
973
+ a hash of params to be passed to the service
974
+ </p>
975
+ </div>
976
+
977
+ </li>
978
+
979
+ <li>
980
+
981
+ <span class='name'>headers</span>
982
+
983
+
984
+ <span class='type'>(<tt>Hash</tt>)</span>
985
+
986
+
987
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
988
+
989
+
990
+ &mdash;
991
+ <div class='inline'><p>
992
+ additional http headers
993
+ </p>
994
+ </div>
995
+
996
+ </li>
997
+
998
+ </ul>
999
+
1000
+
1001
+
1002
+
1003
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
1004
+ <ul class="option">
1005
+
1006
+ <li>
1007
+ <span class="name">id</span>
1008
+ <span class="type">(<tt>Object</tt>)</span>
1009
+ <span class="default">
1010
+
1011
+ </span>
1012
+
1013
+ &mdash; <div class='inline'><p>
1014
+ Part of <tt>/api/roles/:id</tt> path
1015
+ </p>
1016
+ </div>
1017
+
1018
+ </li>
1019
+
1020
+ <li>
1021
+ <span class="name">user_id</span>
1022
+ <span class="type">(<tt>Object</tt>)</span>
1023
+ <span class="default">
1024
+
1025
+ </span>
1026
+
1027
+ &mdash; <div class='inline'><p>
1028
+ Part of <tt>/api/users/:user_id/roles/:id</tt> path
1029
+ </p>
1030
+ </div>
1031
+
1032
+ </li>
1033
+
1034
+ </ul>
1035
+
1036
+
1037
+
1038
+
1039
+ <p class="tag_title">Returns:</p>
1040
+ <ul class="return">
1041
+
1042
+ <li>
1043
+
1044
+
1045
+ <span class='type'>(<tt>Array</tt>)</span>
1046
+
1047
+
1048
+
1049
+ &mdash;
1050
+ <div class='inline'><p>
1051
+ First item: parsed data; second item: raw body
1052
+ </p>
1053
+ </div>
1054
+
1055
+ </li>
1056
+
1057
+ </ul>
1058
+
1059
+ </div><table class="source_code">
1060
+ <tr>
1061
+ <td>
1062
+ <pre class="lines">
1063
+
1064
+
1065
+ 24
1066
+ 25
1067
+ 26</pre>
1068
+ </td>
1069
+ <td>
1070
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/role.rb', line 24</span>
1071
+
1072
+ <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>
1073
+ <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>
1074
+ <span class='rubyid_end end kw'>end</span>
1075
+ </pre>
1076
+ </td>
1077
+ </tr>
1078
+ </table>
1079
+ </div>
1080
+
1081
+ <div class="method_details ">
1082
+ <h3 class="signature " id="update-instance_method">
1083
+
1084
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
1085
+
1086
+
1087
+
1088
+
1089
+
1090
+ </h3><div class="docstring">
1091
+ <div class="discussion">
1092
+ <p>
1093
+ First item: parsed data; second item: raw body
1094
+ </p>
1095
+
1096
+
1097
+ </div>
1098
+ </div>
1099
+ <div class="tags">
1100
+ <p class="tag_title">Parameters:</p>
1101
+ <ul class="param">
1102
+
1103
+ <li>
1104
+
1105
+ <span class='name'>params</span>
1106
+
1107
+
1108
+ <span class='type'>(<tt>Hash</tt>)</span>
1109
+
1110
+
1111
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1112
+
1113
+
1114
+ &mdash;
1115
+ <div class='inline'><p>
1116
+ a hash of params to be passed to the service
1117
+ </p>
1118
+ </div>
1119
+
1120
+ </li>
1121
+
1122
+ <li>
1123
+
1124
+ <span class='name'>headers</span>
1125
+
1126
+
1127
+ <span class='type'>(<tt>Hash</tt>)</span>
1128
+
1129
+
1130
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1131
+
1132
+
1133
+ &mdash;
1134
+ <div class='inline'><p>
1135
+ additional http headers
1136
+ </p>
1137
+ </div>
1138
+
1139
+ </li>
1140
+
1141
+ </ul>
1142
+
1143
+
1144
+
1145
+
1146
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
1147
+ <ul class="option">
1148
+
1149
+ <li>
1150
+ <span class="name">id</span>
1151
+ <span class="type">(<tt>Object</tt>)</span>
1152
+ <span class="default">
1153
+
1154
+ </span>
1155
+
1156
+ &mdash; <div class='inline'><p>
1157
+ Part of <tt>/api/roles/:id</tt> path
1158
+ </p>
1159
+ </div>
1160
+
1161
+ </li>
1162
+
1163
+ <li>
1164
+ <span class="name">user_id</span>
1165
+ <span class="type">(<tt>Object</tt>)</span>
1166
+ <span class="default">
1167
+
1168
+ </span>
1169
+
1170
+ &mdash; <div class='inline'><p>
1171
+ Part of <tt>/api/users/:user_id/roles/:id</tt> path
1172
+ </p>
1173
+ </div>
1174
+
1175
+ </li>
1176
+
1177
+ <li>
1178
+ <span class="name">role</span>
1179
+ <span class="type">(<tt>Hash</tt>)</span>
1180
+ <span class="default">
1181
+
1182
+ </span>
1183
+
1184
+ &mdash; <div class='inline'><p>
1185
+ allowed keys are:
1186
+ </p>
1187
+ <ul>
1188
+ <li>description [String, nil]
1189
+
1190
+ </li>
1191
+ <li>name [String]
1192
+
1193
+ </li>
1194
+ </ul>
1195
+ </div>
1196
+
1197
+ </li>
1198
+
1199
+ </ul>
1200
+
1201
+
1202
+
1203
+
1204
+ <p class="tag_title">Returns:</p>
1205
+ <ul class="return">
1206
+
1207
+ <li>
1208
+
1209
+
1210
+ <span class='type'>(<tt>Array</tt>)</span>
1211
+
1212
+
1213
+
1214
+ &mdash;
1215
+ <div class='inline'><p>
1216
+ First item: parsed data; second item: raw body
1217
+ </p>
1218
+ </div>
1219
+
1220
+ </li>
1221
+
1222
+ </ul>
1223
+
1224
+ </div><table class="source_code">
1225
+ <tr>
1226
+ <td>
1227
+ <pre class="lines">
1228
+
1229
+
1230
+ 51
1231
+ 52
1232
+ 53</pre>
1233
+ </td>
1234
+ <td>
1235
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/role.rb', line 51</span>
1236
+
1237
+ <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>
1238
+ <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>
1239
+ <span class='rubyid_end end kw'>end</span>
1240
+ </pre>
1241
+ </td>
1242
+ </tr>
1243
+ </table>
1244
+ </div>
1245
+
1246
+ </div>
1247
+
1248
+ </div>
1249
+
1250
+ <div id="footer">
1251
+ Generated on Mon Mar 18 14:17:41 2013 by
1252
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1253
+ 0.8.5.2 (ruby-1.8.7).
1254
+ </div>
1255
+
1256
+ </body>
1257
+ </html>