foreman_api 0.1.3 → 0.1.4

data/doc/ForemanApi/Resources/User.html

@@ -6,7 +6,7 @@
 <title>
   Class: ForemanApi::Resources::User
   
-    &mdash; Documentation by YARD 0.8.5.2
+    &mdash; Documentation by YARD 0.8.3
   
 </title>
 
@@ -164,9 +164,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -189,9 +188,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -214,9 +212,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -239,9 +236,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -264,9 +260,8 @@ First item: parsed data; second item: raw body.
   
 
   
-    <span class="summary_desc"><div class='inline'><p>
-First item: parsed data; second item: raw body.
-</p>
+    <span class="summary_desc"><div class='inline'>
+<p>First item: parsed data; second item: raw body.</p>
 </div></span>
   
 </li>
@@ -304,10 +299,9 @@ First item: parsed data; second item: raw body.
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 4</span>
 
-<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>
-  <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'>&quot;users&quot;</span><span class='rbrack token'>]</span>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
+  <span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -330,9 +324,8 @@ First item: parsed data; second item: raw body.
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -353,9 +346,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -372,9 +364,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -394,32 +385,23 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>auth_source_id [Numeric]
-
-</li>
-<li>admin [String] Is an admin account?
-
-</li>
-<li>firstname [String]
-
-</li>
-<li>lastname [String]
-
-</li>
-<li>login [String]
-
-</li>
-<li>mail [String]
-
-</li>
-<li>password [String]
-
-</li>
-</ul>
+            &mdash; <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>auth_source_id [Numeric]</p>
+</li><li>
+<p>admin [String] Is an admin account?</p>
+</li><li>
+<p>firstname [String]</p>
+</li><li>
+<p>lastname [String]</p>
+</li><li>
+<p>login [String]</p>
+</li><li>
+<p>mail [String]</p>
+</li><li>
+<p>password [String]</p>
+</li></ul>
 </div>
           
         </li>
@@ -440,9 +422,8 @@ allowed keys are:
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -462,10 +443,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 42</span>
 
-<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>
-  <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>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -482,9 +462,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -505,9 +484,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -524,9 +502,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -564,9 +541,8 @@ additional http headers
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -586,10 +562,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 68</span>
 
-<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>
-  <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>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -606,9 +581,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -629,9 +603,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -648,9 +621,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -670,9 +642,8 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Sort results
-</p>
+            &mdash; <div class='inline'>
+<p>Sort results</p>
 </div>
           
         </li>
@@ -684,9 +655,8 @@ Sort results
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Paginate results
-</p>
+            &mdash; <div class='inline'>
+<p>Paginate results</p>
 </div>
           
         </li>
@@ -698,9 +668,8 @@ Paginate results
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Number of entries per request
-</p>
+            &mdash; <div class='inline'>
+<p>Number of entries per request</p>
 </div>
           
         </li>
@@ -712,9 +681,8 @@ Number of entries per request
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Filter results
-</p>
+            &mdash; <div class='inline'>
+<p>Filter results</p>
 </div>
           
         </li>
@@ -735,9 +703,8 @@ Filter results
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -757,10 +724,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 16</span>
 
-<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>
-  <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>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -777,9 +743,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -800,9 +765,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -819,9 +783,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -859,9 +822,8 @@ additional http headers
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -881,10 +843,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 25</span>
 
-<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>
-  <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>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -901,9 +862,8 @@ First item: parsed data; second item: raw body
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>
-First item: parsed data; second item: raw body
-</p>
+    
+<p>First item: parsed data; second item: raw body</p>
 
 
   </div>
@@ -924,9 +884,8 @@ First item: parsed data; second item: raw body
       
       
         &mdash;
-        <div class='inline'><p>
-a hash of params to be passed to the service
-</p>
+        <div class='inline'>
+<p>a hash of params to be passed to the service</p>
 </div>
       
     </li>
@@ -943,9 +902,8 @@ a hash of params to be passed to the service
       
       
         &mdash;
-        <div class='inline'><p>
-additional http headers
-</p>
+        <div class='inline'>
+<p>additional http headers</p>
 </div>
       
     </li>
@@ -974,29 +932,21 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>admin [String] Is an admin account?
-
-</li>
-<li>firstname [String, nil]
-
-</li>
-<li>lastname [String, nil]
-
-</li>
-<li>login [String]
-
-</li>
-<li>mail [String]
-
-</li>
-<li>password [String]
-
-</li>
-</ul>
+            &mdash; <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>admin [String] Is an admin account?</p>
+</li><li>
+<p>firstname [String, nil]</p>
+</li><li>
+<p>lastname [String, nil]</p>
+</li><li>
+<p>login [String]</p>
+</li><li>
+<p>mail [String]</p>
+</li><li>
+<p>password [String]</p>
+</li></ul>
 </div>
           
         </li>
@@ -1017,9 +967,8 @@ allowed keys are:
       
       
         &mdash;
-        <div class='inline'><p>
-First item: parsed data; second item: raw body
-</p>
+        <div class='inline'>
+<p>First item: parsed data; second item: raw body</p>
 </div>
       
     </li>
@@ -1039,10 +988,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 59</span>
 
-<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>
-  <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>
-<span class='rubyid_end end kw'>end</span>
-</pre>
+<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -1053,9 +1001,9 @@ First item: parsed data; second item: raw body
 </div>
 
     <div id="footer">
-  Generated on Tue Mar 19 09:50:23 2013 by
+  Generated on Thu Jun 20 12:05:20 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.5.2 (ruby-1.8.7).
+  0.8.3 (ruby-1.9.3).
 </div>
 
   </body>