doc/KatelloApi/Resources/SmartProxy.html in katello_api-0.0.3 vs doc/KatelloApi/Resources/SmartProxy.html in katello_api-0.0.4
- old
+ new
@@ -4,17 +4,17 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: KatelloApi::Resources::SmartProxy
- — Documentation by YARD 0.8.5.2
+ — Documentation by YARD 0.8.7.3
</title>
- <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
- <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!" + escape(window.location.href);
@@ -176,13 +176,12 @@
- <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>
@@ -201,13 +200,12 @@
- <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>
@@ -226,13 +224,12 @@
- <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>
@@ -251,13 +248,12 @@
- <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>
@@ -276,13 +272,12 @@
- <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>
@@ -332,14 +327,13 @@
6</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/smart_proxy.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_KatelloApi constant id'>KatelloApi</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'>"smart_proxies"</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'>KatelloApi</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'>"</span><span class='tstring_content'>smart_proxies</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -358,13 +352,12 @@
</h3><div class="docstring">
<div class="discussion">
- <p>
-First item: parsed data; second item: raw body
-</p>
+
+<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
@@ -381,13 +374,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <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>
@@ -400,13 +392,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <div class='inline'><p>
-additional http headers
-</p>
+ <div class='inline'>
+<p>additional http headers</p>
</div>
</li>
</ul>
@@ -422,22 +413,17 @@
<span class="type">(<tt>Hash</tt>)</span>
<span class="default">
</span>
- — <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>name [String] the smart proxy name
-
-</li>
-<li>url [String] the smart proxy url starting with ‘http://’ or
-‘https://’
-
-</li>
-</ul>
+ — <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>name [String] the smart proxy name</p>
+</li><li>
+<p>url [String] the smart proxy url starting with ‘http://’ or ‘https://’</p>
+</li></ul>
</div>
</li>
</ul>
@@ -454,13 +440,12 @@
<span class='type'>(<tt>Array</tt>)</span>
—
- <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>
</ul>
@@ -476,14 +461,13 @@
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/smart_proxy.rb', line 35</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>
</div>
@@ -496,13 +480,12 @@
</h3><div class="docstring">
<div class="discussion">
- <p>
-First item: parsed data; second item: raw body
-</p>
+
+<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
@@ -519,13 +502,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <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>
@@ -538,13 +520,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <div class='inline'><p>
-additional http headers
-</p>
+ <div class='inline'>
+<p>additional http headers</p>
</div>
</li>
</ul>
@@ -560,13 +541,12 @@
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
- — <div class='inline'><p>
-domain name (no slashes)
-</p>
+ — <div class='inline'>
+<p>domain name (no slashes)</p>
</div>
</li>
</ul>
@@ -583,13 +563,12 @@
<span class='type'>(<tt>Array</tt>)</span>
—
- <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>
</ul>
@@ -605,14 +584,13 @@
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/smart_proxy.rb', line 57</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>
</div>
@@ -625,13 +603,12 @@
</h3><div class="docstring">
<div class="discussion">
- <p>
-First item: parsed data; second item: raw body
-</p>
+
+<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
@@ -648,13 +625,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <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>
@@ -667,13 +643,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <div class='inline'><p>
-additional http headers
-</p>
+ <div class='inline'>
+<p>additional http headers</p>
</div>
</li>
</ul>
@@ -689,13 +664,12 @@
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
- — <div class='inline'><p>
-sort results
-</p>
+ — <div class='inline'>
+<p>sort results</p>
</div>
</li>
<li>
@@ -703,13 +677,12 @@
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
- — <div class='inline'><p>
-filter results
-</p>
+ — <div class='inline'>
+<p>filter results</p>
</div>
</li>
</ul>
@@ -726,13 +699,12 @@
<span class='type'>(<tt>Array</tt>)</span>
—
- <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>
</ul>
@@ -748,14 +720,13 @@
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/smart_proxy.rb', line 14</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>
</div>
@@ -768,13 +739,12 @@
</h3><div class="docstring">
<div class="discussion">
- <p>
-First item: parsed data; second item: raw body
-</p>
+
+<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
@@ -791,13 +761,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <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>
@@ -810,13 +779,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <div class='inline'><p>
-additional http headers
-</p>
+ <div class='inline'>
+<p>additional http headers</p>
</div>
</li>
</ul>
@@ -832,13 +800,12 @@
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
- — <div class='inline'><p>
-domain name (no slashes)
-</p>
+ — <div class='inline'>
+<p>domain name (no slashes)</p>
</div>
</li>
</ul>
@@ -855,13 +822,12 @@
<span class='type'>(<tt>Array</tt>)</span>
—
- <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>
</ul>
@@ -877,14 +843,13 @@
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/smart_proxy.rb', line 23</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>
</div>
@@ -897,13 +862,12 @@
</h3><div class="docstring">
<div class="discussion">
- <p>
-First item: parsed data; second item: raw body
-</p>
+
+<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
@@ -920,13 +884,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <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>
@@ -939,13 +902,12 @@
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
- <div class='inline'><p>
-additional http headers
-</p>
+ <div class='inline'>
+<p>additional http headers</p>
</div>
</li>
</ul>
@@ -961,13 +923,12 @@
<span class="type">(<tt>Object</tt>)</span>
<span class="default">
</span>
- — <div class='inline'><p>
-Part of <tt>/api/smart_proxies/:id</tt> path
-</p>
+ — <div class='inline'>
+<p>Part of <tt>/api/smart_proxies/:id</tt> path</p>
</div>
</li>
<li>
@@ -975,22 +936,17 @@
<span class="type">(<tt>Hash</tt>)</span>
<span class="default">
</span>
- — <div class='inline'><p>
-allowed keys are:
-</p>
-<ul>
-<li>name [String] the smart proxy name
-
-</li>
-<li>url [String] the smart proxy url starting with ‘http://’ or
-‘https://’
-
-</li>
-</ul>
+ — <div class='inline'>
+<p>allowed keys are:</p>
+<ul><li>
+<p>name [String] the smart proxy name</p>
+</li><li>
+<p>url [String] the smart proxy url starting with ‘http://’ or ‘https://’</p>
+</li></ul>
</div>
</li>
</ul>
@@ -1007,13 +963,12 @@
<span class='type'>(<tt>Array</tt>)</span>
—
- <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>
</ul>
@@ -1029,26 +984,25 @@
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/smart_proxy.rb', line 48</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>
</div>
</div>
</div>
<div id="footer">
- Generated on Mon Mar 18 14:17:46 2013 by
+ Generated on Wed Jan 15 20:45:17 2014 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.7.3 (ruby-1.9.3).
</div>
</body>
</html>
\ No newline at end of file