foreman_api 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +3 -0
- data/Gemfile +2 -0
- data/Rakefile +0 -1
- data/doc/ForemanApi.html +5 -5
- data/doc/ForemanApi/Resources.html +6 -6
- data/doc/ForemanApi/Resources/Architecture.html +260 -127
- data/doc/ForemanApi/Resources/Audit.html +118 -51
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +314 -163
- data/doc/ForemanApi/Resources/Bookmark.html +266 -131
- data/doc/ForemanApi/Resources/CommonParameter.html +260 -127
- data/doc/ForemanApi/Resources/ComputeResource.html +314 -165
- data/doc/ForemanApi/Resources/ConfigTemplate.html +387 -195
- data/doc/ForemanApi/Resources/Dashboard.html +53 -27
- data/doc/ForemanApi/Resources/Domain.html +275 -137
- data/doc/ForemanApi/Resources/Environment.html +254 -123
- data/doc/ForemanApi/Resources/FactValue.html +75 -32
- data/doc/ForemanApi/Resources/Home.html +92 -43
- data/doc/ForemanApi/Resources/Host.html +401 -212
- data/doc/ForemanApi/Resources/HostClass.html +698 -0
- data/doc/ForemanApi/Resources/Hostgroup.html +308 -159
- data/doc/ForemanApi/Resources/HostgroupClass.html +712 -0
- data/doc/ForemanApi/Resources/Image.html +284 -143
- data/doc/ForemanApi/Resources/LookupKey.html +295 -140
- data/doc/ForemanApi/Resources/Medium.html +278 -145
- data/doc/ForemanApi/Resources/Model.html +272 -135
- data/doc/ForemanApi/Resources/OperatingSystem.html +323 -160
- data/doc/ForemanApi/Resources/Parameter.html +1512 -0
- data/doc/ForemanApi/Resources/Ptable.html +266 -131
- data/doc/ForemanApi/Resources/Puppetclass.html +295 -131
- data/doc/ForemanApi/Resources/Report.html +311 -71
- data/doc/ForemanApi/Resources/Role.html +248 -119
- data/doc/ForemanApi/Resources/Setting.html +156 -76
- data/doc/ForemanApi/Resources/SmartProxy.html +257 -125
- data/doc/ForemanApi/Resources/Subnet.html +332 -175
- data/doc/ForemanApi/Resources/TemplateCombination.html +826 -0
- data/doc/ForemanApi/Resources/TemplateKind.html +56 -29
- data/doc/ForemanApi/Resources/User.html +287 -145
- data/doc/ForemanApi/Resources/Usergroup.html +272 -115
- data/doc/_index.html +32 -4
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +10 -0
- data/doc/file.MIT-LICENSE.html +29 -24
- data/doc/file.README.html +60 -59
- data/doc/frames.html +1 -1
- data/doc/index.html +60 -59
- data/doc/method_list.html +434 -266
- data/doc/top-level-namespace.html +3 -3
- data/lib/foreman_api.rb +0 -13
- data/lib/foreman_api/base.rb +77 -7
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/architecture.rb +27 -32
- data/lib/foreman_api/resources/audit.rb +9 -10
- data/lib/foreman_api/resources/auth_source_ldap.rb +47 -52
- data/lib/foreman_api/resources/bookmark.rb +31 -36
- data/lib/foreman_api/resources/common_parameter.rb +27 -32
- data/lib/foreman_api/resources/compute_resource.rb +43 -48
- data/lib/foreman_api/resources/config_template.rb +43 -50
- data/lib/foreman_api/resources/dashboard.rb +4 -5
- data/lib/foreman_api/resources/domain.rb +30 -35
- data/lib/foreman_api/resources/environment.rb +25 -30
- data/lib/foreman_api/resources/fact_value.rb +5 -5
- data/lib/foreman_api/resources/home.rb +7 -9
- data/lib/foreman_api/resources/host.rb +63 -69
- data/lib/foreman_api/resources/host_class.rb +39 -0
- data/lib/foreman_api/resources/hostgroup.rb +43 -48
- data/lib/foreman_api/resources/hostgroup_class.rb +40 -0
- data/lib/foreman_api/resources/image.rb +40 -45
- data/lib/foreman_api/resources/lookup_key.rb +36 -40
- data/lib/foreman_api/resources/medium.rb +29 -34
- data/lib/foreman_api/resources/model.rb +31 -36
- data/lib/foreman_api/resources/operating_system.rb +39 -45
- data/lib/foreman_api/resources/parameter.rb +96 -0
- data/lib/foreman_api/resources/ptable.rb +29 -34
- data/lib/foreman_api/resources/puppetclass.rb +31 -34
- data/lib/foreman_api/resources/report.rb +17 -20
- data/lib/foreman_api/resources/role.rb +25 -30
- data/lib/foreman_api/resources/setting.rb +15 -18
- data/lib/foreman_api/resources/smart_proxy.rb +27 -32
- data/lib/foreman_api/resources/subnet.rb +47 -52
- data/lib/foreman_api/resources/template_combination.rb +21 -25
- data/lib/foreman_api/resources/template_kind.rb +4 -5
- data/lib/foreman_api/resources/user.rb +36 -41
- data/lib/foreman_api/resources/usergroup.rb +25 -30
- data/lib/foreman_api/version.rb +1 -1
- metadata +10 -2
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: ForemanApi::Resources::TemplateKind
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -150,7 +150,7 @@
|
|
150
150
|
<li class="public ">
|
151
151
|
<span class="summary_signature">
|
152
152
|
|
153
|
-
<a href="#index-instance_method" title="#index (instance method)">- (
|
153
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
154
154
|
|
155
155
|
|
156
156
|
|
@@ -164,7 +164,10 @@
|
|
164
164
|
|
165
165
|
|
166
166
|
|
167
|
-
<span class="summary_desc"><div class='inline'
|
167
|
+
<span class="summary_desc"><div class='inline'><p>
|
168
|
+
First item: parsed data; second item: raw body.
|
169
|
+
</p>
|
170
|
+
</div></span>
|
168
171
|
|
169
172
|
</li>
|
170
173
|
|
@@ -201,9 +204,10 @@
|
|
201
204
|
<td>
|
202
205
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/template_kind.rb', line 4</span>
|
203
206
|
|
204
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='
|
205
|
-
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='
|
206
|
-
<span class='kw'>end</span
|
207
|
+
<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>
|
208
|
+
<span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</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'>"template_kinds"</span><span class='rbrack token'>]</span>
|
209
|
+
<span class='rubyid_end end kw'>end</span>
|
210
|
+
</pre>
|
207
211
|
</td>
|
208
212
|
</tr>
|
209
213
|
</table>
|
@@ -218,7 +222,7 @@
|
|
218
222
|
<div class="method_details first">
|
219
223
|
<h3 class="signature first" id="index-instance_method">
|
220
224
|
|
221
|
-
- (<tt>
|
225
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
222
226
|
|
223
227
|
|
224
228
|
|
@@ -226,7 +230,10 @@
|
|
226
230
|
|
227
231
|
</h3><div class="docstring">
|
228
232
|
<div class="discussion">
|
229
|
-
|
233
|
+
<p>
|
234
|
+
First item: parsed data; second item: raw body
|
235
|
+
</p>
|
236
|
+
|
230
237
|
|
231
238
|
</div>
|
232
239
|
</div>
|
@@ -242,12 +249,13 @@
|
|
242
249
|
<span class='type'>(<tt>Hash</tt>)</span>
|
243
250
|
|
244
251
|
|
245
|
-
<em class="default">(defaults to: <tt>{
|
252
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
246
253
|
|
247
254
|
|
248
255
|
—
|
249
|
-
<div class='inline'>
|
250
|
-
|
256
|
+
<div class='inline'><p>
|
257
|
+
a hash of params to be passed to the service
|
258
|
+
</p>
|
251
259
|
</div>
|
252
260
|
|
253
261
|
</li>
|
@@ -260,12 +268,13 @@
|
|
260
268
|
<span class='type'>(<tt>Hash</tt>)</span>
|
261
269
|
|
262
270
|
|
263
|
-
<em class="default">(defaults to: <tt>{
|
271
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
264
272
|
|
265
273
|
|
266
274
|
—
|
267
|
-
<div class='inline'>
|
268
|
-
|
275
|
+
<div class='inline'><p>
|
276
|
+
additional http headers
|
277
|
+
</p>
|
269
278
|
</div>
|
270
279
|
|
271
280
|
</li>
|
@@ -285,8 +294,9 @@
|
|
285
294
|
|
286
295
|
</span>
|
287
296
|
|
288
|
-
— <div class='inline'>
|
289
|
-
|
297
|
+
— <div class='inline'><p>
|
298
|
+
Paginate results
|
299
|
+
</p>
|
290
300
|
</div>
|
291
301
|
|
292
302
|
</li>
|
@@ -298,8 +308,9 @@
|
|
298
308
|
|
299
309
|
</span>
|
300
310
|
|
301
|
-
— <div class='inline'>
|
302
|
-
|
311
|
+
— <div class='inline'><p>
|
312
|
+
Number of entries per request
|
313
|
+
</p>
|
303
314
|
</div>
|
304
315
|
|
305
316
|
</li>
|
@@ -309,6 +320,25 @@
|
|
309
320
|
|
310
321
|
|
311
322
|
|
323
|
+
<p class="tag_title">Returns:</p>
|
324
|
+
<ul class="return">
|
325
|
+
|
326
|
+
<li>
|
327
|
+
|
328
|
+
|
329
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
—
|
334
|
+
<div class='inline'><p>
|
335
|
+
First item: parsed data; second item: raw body
|
336
|
+
</p>
|
337
|
+
</div>
|
338
|
+
|
339
|
+
</li>
|
340
|
+
|
341
|
+
</ul>
|
312
342
|
|
313
343
|
</div><table class="source_code">
|
314
344
|
<tr>
|
@@ -316,20 +346,17 @@
|
|
316
346
|
<pre class="lines">
|
317
347
|
|
318
348
|
|
319
|
-
13
|
320
349
|
14
|
321
350
|
15
|
322
|
-
16
|
323
|
-
17</pre>
|
351
|
+
16</pre>
|
324
352
|
</td>
|
325
353
|
<td>
|
326
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/template_kind.rb', line
|
354
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/template_kind.rb', line 14</span>
|
327
355
|
|
328
|
-
<span class='kw'>def</span> <span class='
|
329
|
-
<span class='
|
330
|
-
|
331
|
-
|
332
|
-
<span class='kw'>end</span></pre>
|
356
|
+
<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>
|
357
|
+
<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>
|
358
|
+
<span class='rubyid_end end kw'>end</span>
|
359
|
+
</pre>
|
333
360
|
</td>
|
334
361
|
</tr>
|
335
362
|
</table>
|
@@ -340,9 +367,9 @@
|
|
340
367
|
</div>
|
341
368
|
|
342
369
|
<div id="footer">
|
343
|
-
Generated on
|
370
|
+
Generated on Tue Mar 19 09:50:27 2013 by
|
344
371
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
345
|
-
0.8.
|
372
|
+
0.8.5.2 (ruby-1.8.7).
|
346
373
|
</div>
|
347
374
|
|
348
375
|
</body>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: ForemanApi::Resources::User
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -150,7 +150,7 @@
|
|
150
150
|
<li class="public ">
|
151
151
|
<span class="summary_signature">
|
152
152
|
|
153
|
-
<a href="#create-instance_method" title="#create (instance method)">- (
|
153
|
+
<a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
|
154
154
|
|
155
155
|
|
156
156
|
|
@@ -164,7 +164,10 @@
|
|
164
164
|
|
165
165
|
|
166
166
|
|
167
|
-
<span class="summary_desc"><div class='inline'
|
167
|
+
<span class="summary_desc"><div class='inline'><p>
|
168
|
+
First item: parsed data; second item: raw body.
|
169
|
+
</p>
|
170
|
+
</div></span>
|
168
171
|
|
169
172
|
</li>
|
170
173
|
|
@@ -172,7 +175,7 @@
|
|
172
175
|
<li class="public ">
|
173
176
|
<span class="summary_signature">
|
174
177
|
|
175
|
-
<a href="#destroy-instance_method" title="#destroy (instance method)">- (
|
178
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
|
176
179
|
|
177
180
|
|
178
181
|
|
@@ -186,7 +189,10 @@
|
|
186
189
|
|
187
190
|
|
188
191
|
|
189
|
-
<span class="summary_desc"><div class='inline'
|
192
|
+
<span class="summary_desc"><div class='inline'><p>
|
193
|
+
First item: parsed data; second item: raw body.
|
194
|
+
</p>
|
195
|
+
</div></span>
|
190
196
|
|
191
197
|
</li>
|
192
198
|
|
@@ -194,7 +200,7 @@
|
|
194
200
|
<li class="public ">
|
195
201
|
<span class="summary_signature">
|
196
202
|
|
197
|
-
<a href="#index-instance_method" title="#index (instance method)">- (
|
203
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
198
204
|
|
199
205
|
|
200
206
|
|
@@ -208,7 +214,10 @@
|
|
208
214
|
|
209
215
|
|
210
216
|
|
211
|
-
<span class="summary_desc"><div class='inline'
|
217
|
+
<span class="summary_desc"><div class='inline'><p>
|
218
|
+
First item: parsed data; second item: raw body.
|
219
|
+
</p>
|
220
|
+
</div></span>
|
212
221
|
|
213
222
|
</li>
|
214
223
|
|
@@ -216,7 +225,7 @@
|
|
216
225
|
<li class="public ">
|
217
226
|
<span class="summary_signature">
|
218
227
|
|
219
|
-
<a href="#show-instance_method" title="#show (instance method)">- (
|
228
|
+
<a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
|
220
229
|
|
221
230
|
|
222
231
|
|
@@ -230,7 +239,10 @@
|
|
230
239
|
|
231
240
|
|
232
241
|
|
233
|
-
<span class="summary_desc"><div class='inline'
|
242
|
+
<span class="summary_desc"><div class='inline'><p>
|
243
|
+
First item: parsed data; second item: raw body.
|
244
|
+
</p>
|
245
|
+
</div></span>
|
234
246
|
|
235
247
|
</li>
|
236
248
|
|
@@ -238,7 +250,7 @@
|
|
238
250
|
<li class="public ">
|
239
251
|
<span class="summary_signature">
|
240
252
|
|
241
|
-
<a href="#update-instance_method" title="#update (instance method)">- (
|
253
|
+
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
|
242
254
|
|
243
255
|
|
244
256
|
|
@@ -252,7 +264,10 @@
|
|
252
264
|
|
253
265
|
|
254
266
|
|
255
|
-
<span class="summary_desc"><div class='inline'
|
267
|
+
<span class="summary_desc"><div class='inline'><p>
|
268
|
+
First item: parsed data; second item: raw body.
|
269
|
+
</p>
|
270
|
+
</div></span>
|
256
271
|
|
257
272
|
</li>
|
258
273
|
|
@@ -289,9 +304,10 @@
|
|
289
304
|
<td>
|
290
305
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 4</span>
|
291
306
|
|
292
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='
|
293
|
-
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='
|
294
|
-
<span class='kw'>end</span
|
307
|
+
<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>
|
308
|
+
<span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</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'>"users"</span><span class='rbrack token'>]</span>
|
309
|
+
<span class='rubyid_end end kw'>end</span>
|
310
|
+
</pre>
|
295
311
|
</td>
|
296
312
|
</tr>
|
297
313
|
</table>
|
@@ -306,7 +322,7 @@
|
|
306
322
|
<div class="method_details first">
|
307
323
|
<h3 class="signature first" id="create-instance_method">
|
308
324
|
|
309
|
-
- (<tt>
|
325
|
+
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
|
310
326
|
|
311
327
|
|
312
328
|
|
@@ -314,7 +330,10 @@
|
|
314
330
|
|
315
331
|
</h3><div class="docstring">
|
316
332
|
<div class="discussion">
|
317
|
-
|
333
|
+
<p>
|
334
|
+
First item: parsed data; second item: raw body
|
335
|
+
</p>
|
336
|
+
|
318
337
|
|
319
338
|
</div>
|
320
339
|
</div>
|
@@ -330,12 +349,13 @@
|
|
330
349
|
<span class='type'>(<tt>Hash</tt>)</span>
|
331
350
|
|
332
351
|
|
333
|
-
<em class="default">(defaults to: <tt>{
|
352
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
334
353
|
|
335
354
|
|
336
355
|
—
|
337
|
-
<div class='inline'>
|
338
|
-
|
356
|
+
<div class='inline'><p>
|
357
|
+
a hash of params to be passed to the service
|
358
|
+
</p>
|
339
359
|
</div>
|
340
360
|
|
341
361
|
</li>
|
@@ -348,12 +368,13 @@
|
|
348
368
|
<span class='type'>(<tt>Hash</tt>)</span>
|
349
369
|
|
350
370
|
|
351
|
-
<em class="default">(defaults to: <tt>{
|
371
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
352
372
|
|
353
373
|
|
354
374
|
—
|
355
|
-
<div class='inline'>
|
356
|
-
|
375
|
+
<div class='inline'><p>
|
376
|
+
additional http headers
|
377
|
+
</p>
|
357
378
|
</div>
|
358
379
|
|
359
380
|
</li>
|
@@ -373,23 +394,32 @@
|
|
373
394
|
|
374
395
|
</span>
|
375
396
|
|
376
|
-
— <div class='inline'>
|
377
|
-
|
378
|
-
|
379
|
-
<
|
380
|
-
|
381
|
-
|
382
|
-
</li
|
383
|
-
<
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
</li
|
389
|
-
<
|
390
|
-
|
391
|
-
|
392
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>auth_source_id [Numeric]
|
402
|
+
|
403
|
+
</li>
|
404
|
+
<li>admin [String] Is an admin account?
|
405
|
+
|
406
|
+
</li>
|
407
|
+
<li>firstname [String]
|
408
|
+
|
409
|
+
</li>
|
410
|
+
<li>lastname [String]
|
411
|
+
|
412
|
+
</li>
|
413
|
+
<li>login [String]
|
414
|
+
|
415
|
+
</li>
|
416
|
+
<li>mail [String]
|
417
|
+
|
418
|
+
</li>
|
419
|
+
<li>password [String]
|
420
|
+
|
421
|
+
</li>
|
422
|
+
</ul>
|
393
423
|
</div>
|
394
424
|
|
395
425
|
</li>
|
@@ -399,6 +429,25 @@
|
|
399
429
|
|
400
430
|
|
401
431
|
|
432
|
+
<p class="tag_title">Returns:</p>
|
433
|
+
<ul class="return">
|
434
|
+
|
435
|
+
<li>
|
436
|
+
|
437
|
+
|
438
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
—
|
443
|
+
<div class='inline'><p>
|
444
|
+
First item: parsed data; second item: raw body
|
445
|
+
</p>
|
446
|
+
</div>
|
447
|
+
|
448
|
+
</li>
|
449
|
+
|
450
|
+
</ul>
|
402
451
|
|
403
452
|
</div><table class="source_code">
|
404
453
|
<tr>
|
@@ -406,20 +455,17 @@
|
|
406
455
|
<pre class="lines">
|
407
456
|
|
408
457
|
|
458
|
+
42
|
409
459
|
43
|
410
|
-
44
|
411
|
-
45
|
412
|
-
46
|
413
|
-
47</pre>
|
460
|
+
44</pre>
|
414
461
|
</td>
|
415
462
|
<td>
|
416
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line
|
463
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 42</span>
|
417
464
|
|
418
|
-
<span class='kw'>def</span> <span class='
|
419
|
-
<span class='
|
420
|
-
|
421
|
-
|
422
|
-
<span class='kw'>end</span></pre>
|
465
|
+
<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>
|
466
|
+
<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>
|
467
|
+
<span class='rubyid_end end kw'>end</span>
|
468
|
+
</pre>
|
423
469
|
</td>
|
424
470
|
</tr>
|
425
471
|
</table>
|
@@ -428,7 +474,7 @@
|
|
428
474
|
<div class="method_details ">
|
429
475
|
<h3 class="signature " id="destroy-instance_method">
|
430
476
|
|
431
|
-
- (<tt>
|
477
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
432
478
|
|
433
479
|
|
434
480
|
|
@@ -436,7 +482,10 @@
|
|
436
482
|
|
437
483
|
</h3><div class="docstring">
|
438
484
|
<div class="discussion">
|
439
|
-
|
485
|
+
<p>
|
486
|
+
First item: parsed data; second item: raw body
|
487
|
+
</p>
|
488
|
+
|
440
489
|
|
441
490
|
</div>
|
442
491
|
</div>
|
@@ -452,12 +501,13 @@
|
|
452
501
|
<span class='type'>(<tt>Hash</tt>)</span>
|
453
502
|
|
454
503
|
|
455
|
-
<em class="default">(defaults to: <tt>{
|
504
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
456
505
|
|
457
506
|
|
458
507
|
—
|
459
|
-
<div class='inline'>
|
460
|
-
|
508
|
+
<div class='inline'><p>
|
509
|
+
a hash of params to be passed to the service
|
510
|
+
</p>
|
461
511
|
</div>
|
462
512
|
|
463
513
|
</li>
|
@@ -470,12 +520,13 @@
|
|
470
520
|
<span class='type'>(<tt>Hash</tt>)</span>
|
471
521
|
|
472
522
|
|
473
|
-
<em class="default">(defaults to: <tt>{
|
523
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
474
524
|
|
475
525
|
|
476
526
|
—
|
477
|
-
<div class='inline'>
|
478
|
-
|
527
|
+
<div class='inline'><p>
|
528
|
+
additional http headers
|
529
|
+
</p>
|
479
530
|
</div>
|
480
531
|
|
481
532
|
</li>
|
@@ -502,6 +553,25 @@
|
|
502
553
|
|
503
554
|
|
504
555
|
|
556
|
+
<p class="tag_title">Returns:</p>
|
557
|
+
<ul class="return">
|
558
|
+
|
559
|
+
<li>
|
560
|
+
|
561
|
+
|
562
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
—
|
567
|
+
<div class='inline'><p>
|
568
|
+
First item: parsed data; second item: raw body
|
569
|
+
</p>
|
570
|
+
</div>
|
571
|
+
|
572
|
+
</li>
|
573
|
+
|
574
|
+
</ul>
|
505
575
|
|
506
576
|
</div><table class="source_code">
|
507
577
|
<tr>
|
@@ -509,20 +579,17 @@
|
|
509
579
|
<pre class="lines">
|
510
580
|
|
511
581
|
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
74
|
516
|
-
75</pre>
|
582
|
+
68
|
583
|
+
69
|
584
|
+
70</pre>
|
517
585
|
</td>
|
518
586
|
<td>
|
519
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line
|
587
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 68</span>
|
520
588
|
|
521
|
-
<span class='kw'>def</span> <span class='
|
522
|
-
<span class='
|
523
|
-
|
524
|
-
|
525
|
-
<span class='kw'>end</span></pre>
|
589
|
+
<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>
|
590
|
+
<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>
|
591
|
+
<span class='rubyid_end end kw'>end</span>
|
592
|
+
</pre>
|
526
593
|
</td>
|
527
594
|
</tr>
|
528
595
|
</table>
|
@@ -531,7 +598,7 @@
|
|
531
598
|
<div class="method_details ">
|
532
599
|
<h3 class="signature " id="index-instance_method">
|
533
600
|
|
534
|
-
- (<tt>
|
601
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
535
602
|
|
536
603
|
|
537
604
|
|
@@ -539,7 +606,10 @@
|
|
539
606
|
|
540
607
|
</h3><div class="docstring">
|
541
608
|
<div class="discussion">
|
542
|
-
|
609
|
+
<p>
|
610
|
+
First item: parsed data; second item: raw body
|
611
|
+
</p>
|
612
|
+
|
543
613
|
|
544
614
|
</div>
|
545
615
|
</div>
|
@@ -555,12 +625,13 @@
|
|
555
625
|
<span class='type'>(<tt>Hash</tt>)</span>
|
556
626
|
|
557
627
|
|
558
|
-
<em class="default">(defaults to: <tt>{
|
628
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
559
629
|
|
560
630
|
|
561
631
|
—
|
562
|
-
<div class='inline'>
|
563
|
-
|
632
|
+
<div class='inline'><p>
|
633
|
+
a hash of params to be passed to the service
|
634
|
+
</p>
|
564
635
|
</div>
|
565
636
|
|
566
637
|
</li>
|
@@ -573,12 +644,13 @@
|
|
573
644
|
<span class='type'>(<tt>Hash</tt>)</span>
|
574
645
|
|
575
646
|
|
576
|
-
<em class="default">(defaults to: <tt>{
|
647
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
577
648
|
|
578
649
|
|
579
650
|
—
|
580
|
-
<div class='inline'>
|
581
|
-
|
651
|
+
<div class='inline'><p>
|
652
|
+
additional http headers
|
653
|
+
</p>
|
582
654
|
</div>
|
583
655
|
|
584
656
|
</li>
|
@@ -598,8 +670,9 @@
|
|
598
670
|
|
599
671
|
</span>
|
600
672
|
|
601
|
-
— <div class='inline'>
|
602
|
-
|
673
|
+
— <div class='inline'><p>
|
674
|
+
Sort results
|
675
|
+
</p>
|
603
676
|
</div>
|
604
677
|
|
605
678
|
</li>
|
@@ -611,8 +684,9 @@
|
|
611
684
|
|
612
685
|
</span>
|
613
686
|
|
614
|
-
— <div class='inline'>
|
615
|
-
|
687
|
+
— <div class='inline'><p>
|
688
|
+
Paginate results
|
689
|
+
</p>
|
616
690
|
</div>
|
617
691
|
|
618
692
|
</li>
|
@@ -624,8 +698,9 @@
|
|
624
698
|
|
625
699
|
</span>
|
626
700
|
|
627
|
-
— <div class='inline'>
|
628
|
-
|
701
|
+
— <div class='inline'><p>
|
702
|
+
Number of entries per request
|
703
|
+
</p>
|
629
704
|
</div>
|
630
705
|
|
631
706
|
</li>
|
@@ -637,8 +712,9 @@
|
|
637
712
|
|
638
713
|
</span>
|
639
714
|
|
640
|
-
— <div class='inline'>
|
641
|
-
|
715
|
+
— <div class='inline'><p>
|
716
|
+
Filter results
|
717
|
+
</p>
|
642
718
|
</div>
|
643
719
|
|
644
720
|
</li>
|
@@ -648,6 +724,25 @@
|
|
648
724
|
|
649
725
|
|
650
726
|
|
727
|
+
<p class="tag_title">Returns:</p>
|
728
|
+
<ul class="return">
|
729
|
+
|
730
|
+
<li>
|
731
|
+
|
732
|
+
|
733
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
734
|
+
|
735
|
+
|
736
|
+
|
737
|
+
—
|
738
|
+
<div class='inline'><p>
|
739
|
+
First item: parsed data; second item: raw body
|
740
|
+
</p>
|
741
|
+
</div>
|
742
|
+
|
743
|
+
</li>
|
744
|
+
|
745
|
+
</ul>
|
651
746
|
|
652
747
|
</div><table class="source_code">
|
653
748
|
<tr>
|
@@ -655,20 +750,17 @@
|
|
655
750
|
<pre class="lines">
|
656
751
|
|
657
752
|
|
658
|
-
15
|
659
753
|
16
|
660
754
|
17
|
661
|
-
18
|
662
|
-
19</pre>
|
755
|
+
18</pre>
|
663
756
|
</td>
|
664
757
|
<td>
|
665
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line
|
758
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 16</span>
|
666
759
|
|
667
|
-
<span class='kw'>def</span> <span class='
|
668
|
-
<span class='
|
669
|
-
|
670
|
-
|
671
|
-
<span class='kw'>end</span></pre>
|
760
|
+
<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>
|
761
|
+
<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>
|
762
|
+
<span class='rubyid_end end kw'>end</span>
|
763
|
+
</pre>
|
672
764
|
</td>
|
673
765
|
</tr>
|
674
766
|
</table>
|
@@ -677,7 +769,7 @@
|
|
677
769
|
<div class="method_details ">
|
678
770
|
<h3 class="signature " id="show-instance_method">
|
679
771
|
|
680
|
-
- (<tt>
|
772
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
681
773
|
|
682
774
|
|
683
775
|
|
@@ -685,7 +777,10 @@
|
|
685
777
|
|
686
778
|
</h3><div class="docstring">
|
687
779
|
<div class="discussion">
|
688
|
-
|
780
|
+
<p>
|
781
|
+
First item: parsed data; second item: raw body
|
782
|
+
</p>
|
783
|
+
|
689
784
|
|
690
785
|
</div>
|
691
786
|
</div>
|
@@ -701,12 +796,13 @@
|
|
701
796
|
<span class='type'>(<tt>Hash</tt>)</span>
|
702
797
|
|
703
798
|
|
704
|
-
<em class="default">(defaults to: <tt>{
|
799
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
705
800
|
|
706
801
|
|
707
802
|
—
|
708
|
-
<div class='inline'>
|
709
|
-
|
803
|
+
<div class='inline'><p>
|
804
|
+
a hash of params to be passed to the service
|
805
|
+
</p>
|
710
806
|
</div>
|
711
807
|
|
712
808
|
</li>
|
@@ -719,12 +815,13 @@
|
|
719
815
|
<span class='type'>(<tt>Hash</tt>)</span>
|
720
816
|
|
721
817
|
|
722
|
-
<em class="default">(defaults to: <tt>{
|
818
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
723
819
|
|
724
820
|
|
725
821
|
—
|
726
|
-
<div class='inline'>
|
727
|
-
|
822
|
+
<div class='inline'><p>
|
823
|
+
additional http headers
|
824
|
+
</p>
|
728
825
|
</div>
|
729
826
|
|
730
827
|
</li>
|
@@ -751,6 +848,25 @@
|
|
751
848
|
|
752
849
|
|
753
850
|
|
851
|
+
<p class="tag_title">Returns:</p>
|
852
|
+
<ul class="return">
|
853
|
+
|
854
|
+
<li>
|
855
|
+
|
856
|
+
|
857
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
858
|
+
|
859
|
+
|
860
|
+
|
861
|
+
—
|
862
|
+
<div class='inline'><p>
|
863
|
+
First item: parsed data; second item: raw body
|
864
|
+
</p>
|
865
|
+
</div>
|
866
|
+
|
867
|
+
</li>
|
868
|
+
|
869
|
+
</ul>
|
754
870
|
|
755
871
|
</div><table class="source_code">
|
756
872
|
<tr>
|
@@ -760,18 +876,15 @@
|
|
760
876
|
|
761
877
|
25
|
762
878
|
26
|
763
|
-
27
|
764
|
-
28
|
765
|
-
29</pre>
|
879
|
+
27</pre>
|
766
880
|
</td>
|
767
881
|
<td>
|
768
882
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 25</span>
|
769
883
|
|
770
|
-
<span class='kw'>def</span> <span class='
|
771
|
-
<span class='
|
772
|
-
|
773
|
-
|
774
|
-
<span class='kw'>end</span></pre>
|
884
|
+
<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>
|
885
|
+
<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>
|
886
|
+
<span class='rubyid_end end kw'>end</span>
|
887
|
+
</pre>
|
775
888
|
</td>
|
776
889
|
</tr>
|
777
890
|
</table>
|
@@ -780,7 +893,7 @@
|
|
780
893
|
<div class="method_details ">
|
781
894
|
<h3 class="signature " id="update-instance_method">
|
782
895
|
|
783
|
-
- (<tt>
|
896
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
784
897
|
|
785
898
|
|
786
899
|
|
@@ -788,7 +901,10 @@
|
|
788
901
|
|
789
902
|
</h3><div class="docstring">
|
790
903
|
<div class="discussion">
|
791
|
-
|
904
|
+
<p>
|
905
|
+
First item: parsed data; second item: raw body
|
906
|
+
</p>
|
907
|
+
|
792
908
|
|
793
909
|
</div>
|
794
910
|
</div>
|
@@ -804,12 +920,13 @@
|
|
804
920
|
<span class='type'>(<tt>Hash</tt>)</span>
|
805
921
|
|
806
922
|
|
807
|
-
<em class="default">(defaults to: <tt>{
|
923
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
808
924
|
|
809
925
|
|
810
926
|
—
|
811
|
-
<div class='inline'>
|
812
|
-
|
927
|
+
<div class='inline'><p>
|
928
|
+
a hash of params to be passed to the service
|
929
|
+
</p>
|
813
930
|
</div>
|
814
931
|
|
815
932
|
</li>
|
@@ -822,12 +939,13 @@
|
|
822
939
|
<span class='type'>(<tt>Hash</tt>)</span>
|
823
940
|
|
824
941
|
|
825
|
-
<em class="default">(defaults to: <tt>{
|
942
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
826
943
|
|
827
944
|
|
828
945
|
—
|
829
|
-
<div class='inline'>
|
830
|
-
|
946
|
+
<div class='inline'><p>
|
947
|
+
additional http headers
|
948
|
+
</p>
|
831
949
|
</div>
|
832
950
|
|
833
951
|
</li>
|
@@ -856,21 +974,29 @@
|
|
856
974
|
|
857
975
|
</span>
|
858
976
|
|
859
|
-
— <div class='inline'>
|
860
|
-
|
861
|
-
|
862
|
-
<
|
863
|
-
|
864
|
-
|
865
|
-
</li
|
866
|
-
<
|
867
|
-
|
868
|
-
|
869
|
-
|
870
|
-
|
871
|
-
</li
|
872
|
-
<
|
873
|
-
|
977
|
+
— <div class='inline'><p>
|
978
|
+
allowed keys are:
|
979
|
+
</p>
|
980
|
+
<ul>
|
981
|
+
<li>admin [String] Is an admin account?
|
982
|
+
|
983
|
+
</li>
|
984
|
+
<li>firstname [String, nil]
|
985
|
+
|
986
|
+
</li>
|
987
|
+
<li>lastname [String, nil]
|
988
|
+
|
989
|
+
</li>
|
990
|
+
<li>login [String]
|
991
|
+
|
992
|
+
</li>
|
993
|
+
<li>mail [String]
|
994
|
+
|
995
|
+
</li>
|
996
|
+
<li>password [String]
|
997
|
+
|
998
|
+
</li>
|
999
|
+
</ul>
|
874
1000
|
</div>
|
875
1001
|
|
876
1002
|
</li>
|
@@ -880,6 +1006,25 @@
|
|
880
1006
|
|
881
1007
|
|
882
1008
|
|
1009
|
+
<p class="tag_title">Returns:</p>
|
1010
|
+
<ul class="return">
|
1011
|
+
|
1012
|
+
<li>
|
1013
|
+
|
1014
|
+
|
1015
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1016
|
+
|
1017
|
+
|
1018
|
+
|
1019
|
+
—
|
1020
|
+
<div class='inline'><p>
|
1021
|
+
First item: parsed data; second item: raw body
|
1022
|
+
</p>
|
1023
|
+
</div>
|
1024
|
+
|
1025
|
+
</li>
|
1026
|
+
|
1027
|
+
</ul>
|
883
1028
|
|
884
1029
|
</div><table class="source_code">
|
885
1030
|
<tr>
|
@@ -887,20 +1032,17 @@
|
|
887
1032
|
<pre class="lines">
|
888
1033
|
|
889
1034
|
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
64
|
894
|
-
65</pre>
|
1035
|
+
59
|
1036
|
+
60
|
1037
|
+
61</pre>
|
895
1038
|
</td>
|
896
1039
|
<td>
|
897
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line
|
1040
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 59</span>
|
898
1041
|
|
899
|
-
<span class='kw'>def</span> <span class='
|
900
|
-
<span class='
|
901
|
-
|
902
|
-
|
903
|
-
<span class='kw'>end</span></pre>
|
1042
|
+
<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>
|
1043
|
+
<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>
|
1044
|
+
<span class='rubyid_end end kw'>end</span>
|
1045
|
+
</pre>
|
904
1046
|
</td>
|
905
1047
|
</tr>
|
906
1048
|
</table>
|
@@ -911,9 +1053,9 @@
|
|
911
1053
|
</div>
|
912
1054
|
|
913
1055
|
<div id="footer">
|
914
|
-
Generated on
|
1056
|
+
Generated on Tue Mar 19 09:50:23 2013 by
|
915
1057
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
916
|
-
0.8.
|
1058
|
+
0.8.5.2 (ruby-1.8.7).
|
917
1059
|
</div>
|
918
1060
|
|
919
1061
|
</body>
|