foreman_api 0.1.1 → 0.1.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.
- 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::Dashboard
|
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/dashboard.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'>"dashboard"</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
|
+
Filter results
|
299
|
+
</p>
|
290
300
|
</div>
|
291
301
|
|
292
302
|
</li>
|
@@ -296,6 +306,25 @@
|
|
296
306
|
|
297
307
|
|
298
308
|
|
309
|
+
<p class="tag_title">Returns:</p>
|
310
|
+
<ul class="return">
|
311
|
+
|
312
|
+
<li>
|
313
|
+
|
314
|
+
|
315
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
—
|
320
|
+
<div class='inline'><p>
|
321
|
+
First item: parsed data; second item: raw body
|
322
|
+
</p>
|
323
|
+
</div>
|
324
|
+
|
325
|
+
</li>
|
326
|
+
|
327
|
+
</ul>
|
299
328
|
|
300
329
|
</div><table class="source_code">
|
301
330
|
<tr>
|
@@ -303,20 +332,17 @@
|
|
303
332
|
<pre class="lines">
|
304
333
|
|
305
334
|
|
306
|
-
12
|
307
335
|
13
|
308
336
|
14
|
309
|
-
15
|
310
|
-
16</pre>
|
337
|
+
15</pre>
|
311
338
|
</td>
|
312
339
|
<td>
|
313
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/dashboard.rb', line
|
340
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/dashboard.rb', line 13</span>
|
314
341
|
|
315
|
-
<span class='kw'>def</span> <span class='
|
316
|
-
<span class='
|
317
|
-
|
318
|
-
|
319
|
-
<span class='kw'>end</span></pre>
|
342
|
+
<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>
|
343
|
+
<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>
|
344
|
+
<span class='rubyid_end end kw'>end</span>
|
345
|
+
</pre>
|
320
346
|
</td>
|
321
347
|
</tr>
|
322
348
|
</table>
|
@@ -327,9 +353,9 @@
|
|
327
353
|
</div>
|
328
354
|
|
329
355
|
<div id="footer">
|
330
|
-
Generated on
|
356
|
+
Generated on Tue Mar 19 09:50:26 2013 by
|
331
357
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
332
|
-
0.8.
|
358
|
+
0.8.5.2 (ruby-1.8.7).
|
333
359
|
</div>
|
334
360
|
|
335
361
|
</body>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: ForemanApi::Resources::Domain
|
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/domain.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'>"domains"</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,17 +394,23 @@
|
|
373
394
|
|
374
395
|
</span>
|
375
396
|
|
376
|
-
— <div class='inline'>
|
377
|
-
|
378
|
-
|
379
|
-
<
|
380
|
-
|
381
|
-
|
382
|
-
</li
|
383
|
-
<
|
384
|
-
|
385
|
-
|
386
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>dns_id [String, nil] Dns proxy to use within this domain
|
402
|
+
|
403
|
+
</li>
|
404
|
+
<li>domain_parameters_attributes [String] Array of parameters (name, value)
|
405
|
+
|
406
|
+
</li>
|
407
|
+
<li>fullname [String, nil] Full name describing the domain
|
408
|
+
|
409
|
+
</li>
|
410
|
+
<li>name [String] The full dns domain name
|
411
|
+
|
412
|
+
</li>
|
413
|
+
</ul>
|
387
414
|
</div>
|
388
415
|
|
389
416
|
</li>
|
@@ -393,6 +420,25 @@
|
|
393
420
|
|
394
421
|
|
395
422
|
|
423
|
+
<p class="tag_title">Returns:</p>
|
424
|
+
<ul class="return">
|
425
|
+
|
426
|
+
<li>
|
427
|
+
|
428
|
+
|
429
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
—
|
434
|
+
<div class='inline'><p>
|
435
|
+
First item: parsed data; second item: raw body
|
436
|
+
</p>
|
437
|
+
</div>
|
438
|
+
|
439
|
+
</li>
|
440
|
+
|
441
|
+
</ul>
|
396
442
|
|
397
443
|
</div><table class="source_code">
|
398
444
|
<tr>
|
@@ -400,20 +446,17 @@
|
|
400
446
|
<pre class="lines">
|
401
447
|
|
402
448
|
|
449
|
+
39
|
403
450
|
40
|
404
|
-
41
|
405
|
-
42
|
406
|
-
43
|
407
|
-
44</pre>
|
451
|
+
41</pre>
|
408
452
|
</td>
|
409
453
|
<td>
|
410
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line
|
454
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 39</span>
|
411
455
|
|
412
|
-
<span class='kw'>def</span> <span class='
|
413
|
-
<span class='
|
414
|
-
|
415
|
-
|
416
|
-
<span class='kw'>end</span></pre>
|
456
|
+
<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>
|
457
|
+
<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>
|
458
|
+
<span class='rubyid_end end kw'>end</span>
|
459
|
+
</pre>
|
417
460
|
</td>
|
418
461
|
</tr>
|
419
462
|
</table>
|
@@ -422,7 +465,7 @@
|
|
422
465
|
<div class="method_details ">
|
423
466
|
<h3 class="signature " id="destroy-instance_method">
|
424
467
|
|
425
|
-
- (<tt>
|
468
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
426
469
|
|
427
470
|
|
428
471
|
|
@@ -430,7 +473,10 @@
|
|
430
473
|
|
431
474
|
</h3><div class="docstring">
|
432
475
|
<div class="discussion">
|
433
|
-
|
476
|
+
<p>
|
477
|
+
First item: parsed data; second item: raw body
|
478
|
+
</p>
|
479
|
+
|
434
480
|
|
435
481
|
</div>
|
436
482
|
</div>
|
@@ -446,12 +492,13 @@
|
|
446
492
|
<span class='type'>(<tt>Hash</tt>)</span>
|
447
493
|
|
448
494
|
|
449
|
-
<em class="default">(defaults to: <tt>{
|
495
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
450
496
|
|
451
497
|
|
452
498
|
—
|
453
|
-
<div class='inline'>
|
454
|
-
|
499
|
+
<div class='inline'><p>
|
500
|
+
a hash of params to be passed to the service
|
501
|
+
</p>
|
455
502
|
</div>
|
456
503
|
|
457
504
|
</li>
|
@@ -464,12 +511,13 @@
|
|
464
511
|
<span class='type'>(<tt>Hash</tt>)</span>
|
465
512
|
|
466
513
|
|
467
|
-
<em class="default">(defaults to: <tt>{
|
514
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
468
515
|
|
469
516
|
|
470
517
|
—
|
471
|
-
<div class='inline'>
|
472
|
-
|
518
|
+
<div class='inline'><p>
|
519
|
+
additional http headers
|
520
|
+
</p>
|
473
521
|
</div>
|
474
522
|
|
475
523
|
</li>
|
@@ -496,6 +544,25 @@
|
|
496
544
|
|
497
545
|
|
498
546
|
|
547
|
+
<p class="tag_title">Returns:</p>
|
548
|
+
<ul class="return">
|
549
|
+
|
550
|
+
<li>
|
551
|
+
|
552
|
+
|
553
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
554
|
+
|
555
|
+
|
556
|
+
|
557
|
+
—
|
558
|
+
<div class='inline'><p>
|
559
|
+
First item: parsed data; second item: raw body
|
560
|
+
</p>
|
561
|
+
</div>
|
562
|
+
|
563
|
+
</li>
|
564
|
+
|
565
|
+
</ul>
|
499
566
|
|
500
567
|
</div><table class="source_code">
|
501
568
|
<tr>
|
@@ -503,20 +570,17 @@
|
|
503
570
|
<pre class="lines">
|
504
571
|
|
505
572
|
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
69
|
510
|
-
70</pre>
|
573
|
+
63
|
574
|
+
64
|
575
|
+
65</pre>
|
511
576
|
</td>
|
512
577
|
<td>
|
513
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line
|
578
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 63</span>
|
514
579
|
|
515
|
-
<span class='kw'>def</span> <span class='
|
516
|
-
<span class='
|
517
|
-
|
518
|
-
|
519
|
-
<span class='kw'>end</span></pre>
|
580
|
+
<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>
|
581
|
+
<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>
|
582
|
+
<span class='rubyid_end end kw'>end</span>
|
583
|
+
</pre>
|
520
584
|
</td>
|
521
585
|
</tr>
|
522
586
|
</table>
|
@@ -525,7 +589,7 @@
|
|
525
589
|
<div class="method_details ">
|
526
590
|
<h3 class="signature " id="index-instance_method">
|
527
591
|
|
528
|
-
- (<tt>
|
592
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
529
593
|
|
530
594
|
|
531
595
|
|
@@ -533,7 +597,10 @@
|
|
533
597
|
|
534
598
|
</h3><div class="docstring">
|
535
599
|
<div class="discussion">
|
536
|
-
|
600
|
+
<p>
|
601
|
+
First item: parsed data; second item: raw body
|
602
|
+
</p>
|
603
|
+
|
537
604
|
|
538
605
|
</div>
|
539
606
|
</div>
|
@@ -549,12 +616,13 @@
|
|
549
616
|
<span class='type'>(<tt>Hash</tt>)</span>
|
550
617
|
|
551
618
|
|
552
|
-
<em class="default">(defaults to: <tt>{
|
619
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
553
620
|
|
554
621
|
|
555
622
|
—
|
556
|
-
<div class='inline'>
|
557
|
-
|
623
|
+
<div class='inline'><p>
|
624
|
+
a hash of params to be passed to the service
|
625
|
+
</p>
|
558
626
|
</div>
|
559
627
|
|
560
628
|
</li>
|
@@ -567,12 +635,13 @@
|
|
567
635
|
<span class='type'>(<tt>Hash</tt>)</span>
|
568
636
|
|
569
637
|
|
570
|
-
<em class="default">(defaults to: <tt>{
|
638
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
571
639
|
|
572
640
|
|
573
641
|
—
|
574
|
-
<div class='inline'>
|
575
|
-
|
642
|
+
<div class='inline'><p>
|
643
|
+
additional http headers
|
644
|
+
</p>
|
576
645
|
</div>
|
577
646
|
|
578
647
|
</li>
|
@@ -592,8 +661,9 @@
|
|
592
661
|
|
593
662
|
</span>
|
594
663
|
|
595
|
-
— <div class='inline'>
|
596
|
-
|
664
|
+
— <div class='inline'><p>
|
665
|
+
Sort results
|
666
|
+
</p>
|
597
667
|
</div>
|
598
668
|
|
599
669
|
</li>
|
@@ -605,8 +675,9 @@
|
|
605
675
|
|
606
676
|
</span>
|
607
677
|
|
608
|
-
— <div class='inline'>
|
609
|
-
|
678
|
+
— <div class='inline'><p>
|
679
|
+
Paginate results
|
680
|
+
</p>
|
610
681
|
</div>
|
611
682
|
|
612
683
|
</li>
|
@@ -618,8 +689,9 @@
|
|
618
689
|
|
619
690
|
</span>
|
620
691
|
|
621
|
-
— <div class='inline'>
|
622
|
-
|
692
|
+
— <div class='inline'><p>
|
693
|
+
Number of entries per request
|
694
|
+
</p>
|
623
695
|
</div>
|
624
696
|
|
625
697
|
</li>
|
@@ -631,8 +703,9 @@
|
|
631
703
|
|
632
704
|
</span>
|
633
705
|
|
634
|
-
— <div class='inline'>
|
635
|
-
|
706
|
+
— <div class='inline'><p>
|
707
|
+
Filter results
|
708
|
+
</p>
|
636
709
|
</div>
|
637
710
|
|
638
711
|
</li>
|
@@ -642,6 +715,25 @@
|
|
642
715
|
|
643
716
|
|
644
717
|
|
718
|
+
<p class="tag_title">Returns:</p>
|
719
|
+
<ul class="return">
|
720
|
+
|
721
|
+
<li>
|
722
|
+
|
723
|
+
|
724
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
725
|
+
|
726
|
+
|
727
|
+
|
728
|
+
—
|
729
|
+
<div class='inline'><p>
|
730
|
+
First item: parsed data; second item: raw body
|
731
|
+
</p>
|
732
|
+
</div>
|
733
|
+
|
734
|
+
</li>
|
735
|
+
|
736
|
+
</ul>
|
645
737
|
|
646
738
|
</div><table class="source_code">
|
647
739
|
<tr>
|
@@ -649,20 +741,17 @@
|
|
649
741
|
<pre class="lines">
|
650
742
|
|
651
743
|
|
652
|
-
15
|
653
744
|
16
|
654
745
|
17
|
655
|
-
18
|
656
|
-
19</pre>
|
746
|
+
18</pre>
|
657
747
|
</td>
|
658
748
|
<td>
|
659
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line
|
749
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 16</span>
|
660
750
|
|
661
|
-
<span class='kw'>def</span> <span class='
|
662
|
-
<span class='
|
663
|
-
|
664
|
-
|
665
|
-
<span class='kw'>end</span></pre>
|
751
|
+
<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>
|
752
|
+
<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>
|
753
|
+
<span class='rubyid_end end kw'>end</span>
|
754
|
+
</pre>
|
666
755
|
</td>
|
667
756
|
</tr>
|
668
757
|
</table>
|
@@ -671,7 +760,7 @@
|
|
671
760
|
<div class="method_details ">
|
672
761
|
<h3 class="signature " id="show-instance_method">
|
673
762
|
|
674
|
-
- (<tt>
|
763
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
675
764
|
|
676
765
|
|
677
766
|
|
@@ -679,7 +768,10 @@
|
|
679
768
|
|
680
769
|
</h3><div class="docstring">
|
681
770
|
<div class="discussion">
|
682
|
-
|
771
|
+
<p>
|
772
|
+
First item: parsed data; second item: raw body
|
773
|
+
</p>
|
774
|
+
|
683
775
|
|
684
776
|
</div>
|
685
777
|
</div>
|
@@ -695,12 +787,13 @@
|
|
695
787
|
<span class='type'>(<tt>Hash</tt>)</span>
|
696
788
|
|
697
789
|
|
698
|
-
<em class="default">(defaults to: <tt>{
|
790
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
699
791
|
|
700
792
|
|
701
793
|
—
|
702
|
-
<div class='inline'>
|
703
|
-
|
794
|
+
<div class='inline'><p>
|
795
|
+
a hash of params to be passed to the service
|
796
|
+
</p>
|
704
797
|
</div>
|
705
798
|
|
706
799
|
</li>
|
@@ -713,12 +806,13 @@
|
|
713
806
|
<span class='type'>(<tt>Hash</tt>)</span>
|
714
807
|
|
715
808
|
|
716
|
-
<em class="default">(defaults to: <tt>{
|
809
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
717
810
|
|
718
811
|
|
719
812
|
—
|
720
|
-
<div class='inline'>
|
721
|
-
|
813
|
+
<div class='inline'><p>
|
814
|
+
additional http headers
|
815
|
+
</p>
|
722
816
|
</div>
|
723
817
|
|
724
818
|
</li>
|
@@ -738,8 +832,9 @@
|
|
738
832
|
|
739
833
|
</span>
|
740
834
|
|
741
|
-
— <div class='inline'>
|
742
|
-
|
835
|
+
— <div class='inline'><p>
|
836
|
+
May be numerical id or domain name
|
837
|
+
</p>
|
743
838
|
</div>
|
744
839
|
|
745
840
|
</li>
|
@@ -749,6 +844,25 @@
|
|
749
844
|
|
750
845
|
|
751
846
|
|
847
|
+
<p class="tag_title">Returns:</p>
|
848
|
+
<ul class="return">
|
849
|
+
|
850
|
+
<li>
|
851
|
+
|
852
|
+
|
853
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
854
|
+
|
855
|
+
|
856
|
+
|
857
|
+
—
|
858
|
+
<div class='inline'><p>
|
859
|
+
First item: parsed data; second item: raw body
|
860
|
+
</p>
|
861
|
+
</div>
|
862
|
+
|
863
|
+
</li>
|
864
|
+
|
865
|
+
</ul>
|
752
866
|
|
753
867
|
</div><table class="source_code">
|
754
868
|
<tr>
|
@@ -758,18 +872,15 @@
|
|
758
872
|
|
759
873
|
25
|
760
874
|
26
|
761
|
-
27
|
762
|
-
28
|
763
|
-
29</pre>
|
875
|
+
27</pre>
|
764
876
|
</td>
|
765
877
|
<td>
|
766
878
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 25</span>
|
767
879
|
|
768
|
-
<span class='kw'>def</span> <span class='
|
769
|
-
<span class='
|
770
|
-
|
771
|
-
|
772
|
-
<span class='kw'>end</span></pre>
|
880
|
+
<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>
|
881
|
+
<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>
|
882
|
+
<span class='rubyid_end end kw'>end</span>
|
883
|
+
</pre>
|
773
884
|
</td>
|
774
885
|
</tr>
|
775
886
|
</table>
|
@@ -778,7 +889,7 @@
|
|
778
889
|
<div class="method_details ">
|
779
890
|
<h3 class="signature " id="update-instance_method">
|
780
891
|
|
781
|
-
- (<tt>
|
892
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
782
893
|
|
783
894
|
|
784
895
|
|
@@ -786,7 +897,10 @@
|
|
786
897
|
|
787
898
|
</h3><div class="docstring">
|
788
899
|
<div class="discussion">
|
789
|
-
|
900
|
+
<p>
|
901
|
+
First item: parsed data; second item: raw body
|
902
|
+
</p>
|
903
|
+
|
790
904
|
|
791
905
|
</div>
|
792
906
|
</div>
|
@@ -802,12 +916,13 @@
|
|
802
916
|
<span class='type'>(<tt>Hash</tt>)</span>
|
803
917
|
|
804
918
|
|
805
|
-
<em class="default">(defaults to: <tt>{
|
919
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
806
920
|
|
807
921
|
|
808
922
|
—
|
809
|
-
<div class='inline'>
|
810
|
-
|
923
|
+
<div class='inline'><p>
|
924
|
+
a hash of params to be passed to the service
|
925
|
+
</p>
|
811
926
|
</div>
|
812
927
|
|
813
928
|
</li>
|
@@ -820,12 +935,13 @@
|
|
820
935
|
<span class='type'>(<tt>Hash</tt>)</span>
|
821
936
|
|
822
937
|
|
823
|
-
<em class="default">(defaults to: <tt>{
|
938
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
824
939
|
|
825
940
|
|
826
941
|
—
|
827
|
-
<div class='inline'>
|
828
|
-
|
942
|
+
<div class='inline'><p>
|
943
|
+
additional http headers
|
944
|
+
</p>
|
829
945
|
</div>
|
830
946
|
|
831
947
|
</li>
|
@@ -854,17 +970,23 @@
|
|
854
970
|
|
855
971
|
</span>
|
856
972
|
|
857
|
-
— <div class='inline'>
|
858
|
-
|
859
|
-
|
860
|
-
<
|
861
|
-
|
862
|
-
|
863
|
-
</li
|
864
|
-
<
|
865
|
-
|
866
|
-
|
867
|
-
|
973
|
+
— <div class='inline'><p>
|
974
|
+
allowed keys are:
|
975
|
+
</p>
|
976
|
+
<ul>
|
977
|
+
<li>dns_id [String, nil] Dns proxy to use within this domain
|
978
|
+
|
979
|
+
</li>
|
980
|
+
<li>domain_parameters_attributes [String] Array of parameters (name, value)
|
981
|
+
|
982
|
+
</li>
|
983
|
+
<li>fullname [String, nil] Full name describing the domain
|
984
|
+
|
985
|
+
</li>
|
986
|
+
<li>name [String, nil] The full dns domain name
|
987
|
+
|
988
|
+
</li>
|
989
|
+
</ul>
|
868
990
|
</div>
|
869
991
|
|
870
992
|
</li>
|
@@ -874,6 +996,25 @@
|
|
874
996
|
|
875
997
|
|
876
998
|
|
999
|
+
<p class="tag_title">Returns:</p>
|
1000
|
+
<ul class="return">
|
1001
|
+
|
1002
|
+
<li>
|
1003
|
+
|
1004
|
+
|
1005
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1006
|
+
|
1007
|
+
|
1008
|
+
|
1009
|
+
—
|
1010
|
+
<div class='inline'><p>
|
1011
|
+
First item: parsed data; second item: raw body
|
1012
|
+
</p>
|
1013
|
+
</div>
|
1014
|
+
|
1015
|
+
</li>
|
1016
|
+
|
1017
|
+
</ul>
|
877
1018
|
|
878
1019
|
</div><table class="source_code">
|
879
1020
|
<tr>
|
@@ -881,20 +1022,17 @@
|
|
881
1022
|
<pre class="lines">
|
882
1023
|
|
883
1024
|
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
59
|
888
|
-
60</pre>
|
1025
|
+
54
|
1026
|
+
55
|
1027
|
+
56</pre>
|
889
1028
|
</td>
|
890
1029
|
<td>
|
891
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line
|
1030
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 54</span>
|
892
1031
|
|
893
|
-
<span class='kw'>def</span> <span class='
|
894
|
-
<span class='
|
895
|
-
|
896
|
-
|
897
|
-
<span class='kw'>end</span></pre>
|
1032
|
+
<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>
|
1033
|
+
<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>
|
1034
|
+
<span class='rubyid_end end kw'>end</span>
|
1035
|
+
</pre>
|
898
1036
|
</td>
|
899
1037
|
</tr>
|
900
1038
|
</table>
|
@@ -905,9 +1043,9 @@
|
|
905
1043
|
</div>
|
906
1044
|
|
907
1045
|
<div id="footer">
|
908
|
-
Generated on
|
1046
|
+
Generated on Tue Mar 19 09:50:24 2013 by
|
909
1047
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
910
|
-
0.8.
|
1048
|
+
0.8.5.2 (ruby-1.8.7).
|
911
1049
|
</div>
|
912
1050
|
|
913
1051
|
</body>
|