<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Class: KatelloApi::Resources::Changeset — Documentation by YARD 0.8.7.3 </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" 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); </script> <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> </head> <body> <div id="header"> <div id="menu"> <a href="../../_index.html">Index (C)</a> » <span class='title'><span class='object_link'><a href="../../KatelloApi.html" title="KatelloApi (module)">KatelloApi</a></span></span> » <span class='title'><span class='object_link'><a href="../Resources.html" title="KatelloApi::Resources (module)">Resources</a></span></span> » <span class="title">Changeset</span> <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../../class_list.html"> Class List </a> <a class="full_list_link" id="method_list_link" href="../../method_list.html"> Method List </a> <a class="full_list_link" id="file_list_link" href="../../file_list.html"> File List </a> </div> <div class="clear"></div> </div> <iframe id="search_frame"></iframe> <div id="content"><h1>Class: KatelloApi::Resources::Changeset </h1> <dl class="box"> <dt class="r1">Inherits:</dt> <dd class="r1"> <span class="inheritName"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></span> <ul class="fullTree"> <li>Object</li> <li class="next"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></li> <li class="next">KatelloApi::Resources::Changeset</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> <dt class="r2 last">Defined in:</dt> <dd class="r2 last">lib/katello_api/resources/changeset.rb</dd> </dl> <div class="clear"></div> <h2>Constant Summary</h2> <h2>Constant Summary</h2> <h3 class="inherited">Constants inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3> <p class="inherited"><span class='object_link'><a href="../Base.html#API_VERSION-constant" title="KatelloApi::Base::API_VERSION (constant)">Base::API_VERSION</a></span></p> <h2>Instance Attribute Summary</h2> <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3> <p class="inherited"><span class='object_link'><a href="../Base.html#client-instance_method" title="KatelloApi::Base#client (method)">#client</a></span>, <span class='object_link'><a href="../Base.html#config-instance_method" title="KatelloApi::Base#config (method)">#config</a></span></p> <h2> Class Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <h2> Instance Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#apply-instance_method" title="#apply (instance method)">- (Array) <strong>apply</strong>(params = {}, headers = {}) </a> </span> <span class="summary_desc"><div class='inline'> <p>First item: parsed data; second item: raw body.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a> </span> <span class="summary_desc"><div class='inline'> <p>First item: parsed data; second item: raw body.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a> </span> <span class="summary_desc"><div class='inline'> <p>First item: parsed data; second item: raw body.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a> </span> <span class="summary_desc"><div class='inline'> <p>First item: parsed data; second item: raw body.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a> </span> <span class="summary_desc"><div class='inline'> <p>First item: parsed data; second item: raw body.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a> </span> <span class="summary_desc"><div class='inline'> <p>First item: parsed data; second item: raw body.</p> </div></span> </li> </ul> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3> <p class="inherited"><span class='object_link'><a href="../Base.html#http_call-instance_method" title="KatelloApi::Base#http_call (method)">#http_call</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Base.html#method_doc-class_method" title="KatelloApi::Base.method_doc (method)">method_doc</a></span>, <span class='object_link'><a href="../Base.html#perform_call-instance_method" title="KatelloApi::Base#perform_call (method)">#perform_call</a></span>, <span class='object_link'><a href="../Base.html#validate_params%21-instance_method" title="KatelloApi::Base#validate_params! (method)">#validate_params!</a></span>, <span class='object_link'><a href="../Base.html#validation_hash-class_method" title="KatelloApi::Base.validation_hash (method)">validation_hash</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">KatelloApi::Base</a></span></p> </div> <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="doc-class_method"> + (<tt>Object</tt>) <strong>doc</strong> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 4 5 6</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/katello_api/resources/changeset.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'>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'>changesets</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="apply-instance_method"> - (<tt>Array</tt>) <strong>apply</strong>(params = {}, headers = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns First item: parsed data; second item: raw body</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>params</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>a hash of params to be passed to the service</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>additional http headers</p> </div> </li> </ul> <p class="tag_title">Options Hash (<tt>params</tt>):</p> <ul class="option"> <li> <span class="name">id</span> <span class="type">(<tt>Object</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>Part of <tt>/api/changesets/:id/apply</tt> path</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <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"> 59 60 61</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/katello_api/resources/changeset.rb', line 59</span> <span class='kw'>def</span> <span class='id identifier rubyid_apply'>apply</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 class="method_details "> <h3 class="signature " id="create-instance_method"> - (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns First item: parsed data; second item: raw body</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>params</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>a hash of params to be passed to the service</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>additional http headers</p> </div> </li> </ul> <p class="tag_title">Options Hash (<tt>params</tt>):</p> <ul class="option"> <li> <span class="name">environment_id</span> <span class="type">(<tt>Object</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>Part of <tt>/api/environments/:environment_id/changesets</tt> path</p> </div> </li> <li> <span class="name">changeset</span> <span class="type">(<tt>Hash</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>allowed keys are:</p> <ul><li> <p>description [String, nil] the description of the changeset</p> </li><li> <p>name [String] the name of the changeset</p> </li><li> <p>type [String]</p> </li></ul> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <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"> 50 51 52</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/katello_api/resources/changeset.rb', line 50</span> <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> <div class="method_details "> <h3 class="signature " id="destroy-instance_method"> - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns First item: parsed data; second item: raw body</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>params</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>a hash of params to be passed to the service</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>additional http headers</p> </div> </li> </ul> <p class="tag_title">Options Hash (<tt>params</tt>):</p> <ul class="option"> <li> <span class="name">id</span> <span class="type">(<tt>Object</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>Part of <tt>/api/changesets/:id</tt> path</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <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"> 68 69 70</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/katello_api/resources/changeset.rb', line 68</span> <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> <div class="method_details "> <h3 class="signature " id="index-instance_method"> - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns First item: parsed data; second item: raw body</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>params</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>a hash of params to be passed to the service</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>additional http headers</p> </div> </li> </ul> <p class="tag_title">Options Hash (<tt>params</tt>):</p> <ul class="option"> <li> <span class="name">environment_id</span> <span class="type">(<tt>Object</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>Part of <tt>/api/environments/:environment_id/changesets</tt> path</p> </div> </li> <li> <span class="name">name</span> <span class="type">(<tt>String</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>an optional changeset name to filter upon</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <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"> 14 15 16</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/katello_api/resources/changeset.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_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 class="method_details "> <h3 class="signature " id="show-instance_method"> - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns First item: parsed data; second item: raw body</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>params</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>a hash of params to be passed to the service</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>additional http headers</p> </div> </li> </ul> <p class="tag_title">Options Hash (<tt>params</tt>):</p> <ul class="option"> <li> <span class="name">id</span> <span class="type">(<tt>Object</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>Part of <tt>/api/changesets/:id</tt> path</p> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <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"> 23 24 25</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/katello_api/resources/changeset.rb', line 23</span> <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> <div class="method_details "> <h3 class="signature " id="update-instance_method"> - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {}) </h3><div class="docstring"> <div class="discussion"> <p>Returns First item: parsed data; second item: raw body</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>params</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>a hash of params to be passed to the service</p> </div> </li> <li> <span class='name'>headers</span> <span class='type'>(<tt>Hash</tt>)</span> <em class="default">(defaults to: <tt>{}</tt>)</em> — <div class='inline'> <p>additional http headers</p> </div> </li> </ul> <p class="tag_title">Options Hash (<tt>params</tt>):</p> <ul class="option"> <li> <span class="name">id</span> <span class="type">(<tt>Object</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>Part of <tt>/api/changesets/:id</tt> path</p> </div> </li> <li> <span class="name">changeset</span> <span class="type">(<tt>Hash</tt>)</span> <span class="default"> </span> — <div class='inline'> <p>allowed keys are:</p> <ul><li> <p>description [String, nil] the description of the changeset</p> </li><li> <p>name [String] the name of the changeset</p> </li></ul> </div> </li> </ul> <p class="tag_title">Returns:</p> <ul class="return"> <li> <span class='type'>(<tt>Array</tt>)</span> — <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"> 36 37 38</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/katello_api/resources/changeset.rb', line 36</span> <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 Wed Jan 15 20:45:16 2014 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.7.3 (ruby-1.9.3). </div> </body> </html>