foreman_api 0.1.3 → 0.1.4

data/doc/ForemanApi/Resources/Domain.html

@@ -6,7 +6,7 @@
 <title>
   Class: ForemanApi::Resources::Domain
   
-    &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/domain.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;domains&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'>domains</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,23 +385,17 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>dns_id [String, nil] Dns proxy to use within this domain
-
-</li>
-<li>domain_parameters_attributes [String] Array of parameters (name, value)
-
-</li>
-<li>fullname [String, nil] Full name describing the domain
-
-</li>
-<li>name [String] The full dns domain name
-
-</li>
-</ul>
+            &mdash; <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>dns_id [String, nil] Dns proxy to use within this domain</p>
+</li><li>
+<p>domain_parameters_attributes [String] Array of parameters (name, value)</p>
+</li><li>
+<p>fullname [String, nil] Full name describing the domain</p>
+</li><li>
+<p>name [String] The full dns domain name</p>
+</li></ul>
 </div>
           
         </li>
@@ -431,9 +416,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>
@@ -453,10 +437,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 39</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>
@@ -473,9 +456,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>
@@ -496,9 +478,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>
@@ -515,9 +496,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>
@@ -555,9 +535,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>
@@ -577,10 +556,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 63</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>
@@ -597,9 +575,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>
@@ -620,9 +597,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>
@@ -639,9 +615,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>
@@ -661,9 +636,8 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Sort results
-</p>
+            &mdash; <div class='inline'>
+<p>Sort results</p>
 </div>
           
         </li>
@@ -675,9 +649,8 @@ Sort results
             
           </span>
           
-            &mdash; <div class='inline'><p>
-Paginate results
-</p>
+            &mdash; <div class='inline'>
+<p>Paginate results</p>
 </div>
           
         </li>
@@ -689,9 +662,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>
@@ -703,9 +675,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>
@@ -726,9 +697,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>
@@ -748,10 +718,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.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>
@@ -768,9 +737,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>
@@ -791,9 +759,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>
@@ -810,9 +777,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>
@@ -832,9 +798,8 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-May be numerical id or domain name
-</p>
+            &mdash; <div class='inline'>
+<p>May be numerical id or domain name</p>
 </div>
           
         </li>
@@ -855,9 +820,8 @@ May be numerical id or domain name
       
       
         &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>
@@ -877,10 +841,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.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>
@@ -897,9 +860,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>
@@ -920,9 +882,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>
@@ -939,9 +900,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>
@@ -970,23 +930,17 @@ additional http headers
             
           </span>
           
-            &mdash; <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>dns_id [String, nil] Dns proxy to use within this domain
-
-</li>
-<li>domain_parameters_attributes [String] Array of parameters (name, value)
-
-</li>
-<li>fullname [String, nil] Full name describing the domain
-
-</li>
-<li>name [String, nil] The full dns domain name
-
-</li>
-</ul>
+            &mdash; <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>dns_id [String, nil] Dns proxy to use within this domain</p>
+</li><li>
+<p>domain_parameters_attributes [String] Array of parameters (name, value)</p>
+</li><li>
+<p>fullname [String, nil] Full name describing the domain</p>
+</li><li>
+<p>name [String, nil] The full dns domain name</p>
+</li></ul>
 </div>
           
         </li>
@@ -1007,9 +961,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>
@@ -1029,10 +982,9 @@ First item: parsed data; second item: raw body
     <td>
       <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/domain.rb', line 54</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>
@@ -1043,9 +995,9 @@ First item: parsed data; second item: raw body
 </div>
 
     <div id="footer">
-  Generated on Tue Mar 19 09:50:24 2013 by
+  Generated on Thu Jun 20 12:05:21 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>