doc/ForemanApi/Resources/TemplateKind.html in foreman_api-0.1.1 vs doc/ForemanApi/Resources/TemplateKind.html in foreman_api-0.1.2

- old
+ new

@@ -4,11 +4,11 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Class: ForemanApi::Resources::TemplateKind - &mdash; Documentation by YARD 0.8.3 + &mdash; Documentation by YARD 0.8.5.2 </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> @@ -148,11 +148,11 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> - <a href="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</strong>(params = { }, headers = { }) </a> + <a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a> </span> @@ -162,11 +162,14 @@ - <span class="summary_desc"><div class='inline'></div></span> + <span class="summary_desc"><div class='inline'><p> +First item: parsed data; second item: raw body. +</p> +</div></span> </li> </ul> @@ -199,13 +202,14 @@ 6</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/template_kind.rb', line 4</span> -<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'>template_kinds</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> -<span class='kw'>end</span></pre> +<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;template_kinds&quot;</span><span class='rbrack token'>]</span> +<span class='rubyid_end end kw'>end</span> +</pre> </td> </tr> </table> </div> @@ -216,20 +220,23 @@ <div class="method_details first"> <h3 class="signature first" id="index-instance_method"> - - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { }) + - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {}) </h3><div class="docstring"> <div class="discussion"> - + <p> +First item: parsed data; second item: raw body +</p> + </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> @@ -240,16 +247,17 @@ <span class='type'>(<tt>Hash</tt>)</span> - <em class="default">(defaults to: <tt>{ }</tt>)</em> + <em class="default">(defaults to: <tt>{}</tt>)</em> &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> <li> @@ -258,16 +266,17 @@ <span class='type'>(<tt>Hash</tt>)</span> - <em class="default">(defaults to: <tt>{ }</tt>)</em> + <em class="default">(defaults to: <tt>{}</tt>)</em> &mdash; - <div class='inline'> -<p>additional http headers</p> + <div class='inline'><p> +additional http headers +</p> </div> </li> </ul> @@ -283,12 +292,13 @@ <span class="type">(<tt>String</tt>)</span> <span class="default"> </span> - &mdash; <div class='inline'> -<p>Paginate results</p> + &mdash; <div class='inline'><p> +Paginate results +</p> </div> </li> <li> @@ -296,54 +306,71 @@ <span class="type">(<tt>String</tt>)</span> <span class="default"> </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> </ul> +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + &mdash; + <div class='inline'><p> +First item: parsed data; second item: raw body +</p> +</div> + + </li> + +</ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -13 14 15 -16 -17</pre> +16</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/template_kind.rb', line 13</span> + <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/template_kind.rb', line 14</span> -<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_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span> - <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/template_kinds</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> - <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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> +<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> </td> </tr> </table> </div> </div> </div> <div id="footer"> - Generated on Mon Jan 21 15:44:36 2013 by + Generated on Tue Mar 19 09:50:27 2013 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.3 (ruby-1.9.3). + 0.8.5.2 (ruby-1.8.7). </div> </body> </html> \ No newline at end of file