https://wiki.yoctoproject.org/wiki/api.php?action=feedcontributions&feedformat=atom&user=Ciprian+Pratia 2026-05-15T09:38:10Z User contributions MediaWiki 1.39.5 https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Tasks&diff=10799 2013-07-29T16:32:31Z

<p>Ciprian Pratia: /* Response */</p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /tasks || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || &quot;&lt;FIELD&gt;:&lt;ORDER_DIRECTION&gt;&quot;<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;model&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;build&lt;/span&gt; || number || 2 || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;cpu_usage&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;disk_io&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;elapsed_time&lt;/span&gt; || number representation of date || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number representation of date || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors_no&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;line_number&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log_file&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;order&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;path_to_sstate_obj&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;py_stack_trace&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;script_type&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;source_url&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_checksum&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_result&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_executed&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_name&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warning&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings_no&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;work_directory&lt;/span&gt; || string array || - || YES || - || - || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Tasks&diff=10798 2013-07-29T16:31:48Z

<p>Ciprian Pratia: /* Response */</p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /tasks || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || &quot;&lt;FIELD&gt;:&lt;ORDER_DIRECTION&gt;&quot;<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;model&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;build&lt;/span&gt; || number || 2 || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;cpu_usage&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;disk_io&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;elapsed_time&lt;/span&gt; || number representation of date || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number representation of date || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors_no&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;line_number&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log_file&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;order&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;path_to_sstate_obj&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;py_stack_trace&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;script_type&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;source_url&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_checksum&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_result&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_executed&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_name&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warning&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings_no&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;work_directory&lt;/span&gt; || string array || - || YES || - || - || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Tasks&diff=10797 2013-07-29T16:30:39Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /tasks || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || &quot;&lt;FIELD&gt;:&lt;ORDER_DIRECTION&gt;&quot;<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;model&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;build&lt;/span&gt; || number || 2 || YES || - || - || -|-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;cpu_usage&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;disk_io&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;elapsed_time&lt;/span&gt; || number representation of date || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number representation of date || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors_no&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;line_number&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log_file&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;order&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;path_to_sstate_obj&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;py_stack_trace&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;script_type&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;source_url&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_checksum&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_result&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_executed&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_name&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warning&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings_no&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;work_directory&lt;/span&gt; || string array || - || YES || - || - || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Tasks&diff=10795 2013-07-29T16:02:25Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /tasks || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || &quot;&lt;FIELD&gt;:&lt;ORDER_DIRECTION&gt;&quot;<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;model&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;build&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;cpu_usage&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;disk_io&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;elapsed_time&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors_no&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;line_number&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log_file&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;order&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;path_to_sstate_obj&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;py_stack_trace&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;script_type&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;source_url&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_checksum&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;sstate_result&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_executed&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;task_name&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warning&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings_no&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;work_directory&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Packages&diff=10788 2013-07-25T14:01:46Z

<p>Ciprian Pratia: Created page with &quot;Category:REST API Contracts === Endpoints === {| class=&quot;wikitable&quot; |- ! Method !! Endpoint !! Body !! Description !! Comments |- | GET || /builds || JSON || Returns page si...&quot;</p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || &quot;&lt;FIELD&gt;:&lt;ORDER_DIRECTION&gt;&quot;<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;model&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;started_on&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completed_on&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors_no&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings_no&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;cooker_log_path&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;image_fstypes&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Tasks&diff=10787 2013-07-25T14:01:11Z

<p>Ciprian Pratia: Created page with &quot;Category:REST API Contracts === Endpoints === {| class=&quot;wikitable&quot; |- ! Method !! Endpoint !! Body !! Description !! Comments |- | GET || /builds || JSON || Returns page si...&quot;</p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || &quot;&lt;FIELD&gt;:&lt;ORDER_DIRECTION&gt;&quot;<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;model&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;started_on&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completed_on&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors_no&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings_no&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;cooker_log_path&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;image_fstypes&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10773 2013-07-23T15:09:21Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || &quot;&lt;FIELD&gt;:&lt;ORDER_DIRECTION&gt;&quot;<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;model&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;started_on&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completed_on&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors_no&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings_no&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;cooker_log_path&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;image_fstypes&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10770 2013-07-23T10:03:18Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || -<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;string&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10769 2013-07-23T10:02:36Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || -<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;pk&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;string&lt;/span&gt; || number || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt; || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#0066FF&quot;&gt;fields&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10768 2013-07-23T09:51:55Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | search || string || Search string for all fields || -<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;VALUE&gt;&quot;.<br /> |-<br /> | orderby || string || the name of the field that determens the soring of the resuls. || -<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10767 2013-07-22T15:54:06Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;ASC/DESC&gt;&quot;. If field = freeText, &quot;freeText:&lt;SEARCH_STRING&gt;&quot;.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10766 2013-07-22T15:53:46Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;ASC:DESC&gt;&quot;. If field = freeText, &quot;freeText:&lt;SEARCH_STRING&gt;&quot;.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10765 2013-07-22T15:53:05Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || The general form: &quot;&lt;FIELD&gt;:&lt;ASC|DESC&gt;&quot;. If field = freeText, &quot;freeText:&lt;SEARCH_STRING&gt;&quot;.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10759 2013-07-22T13:17:08Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments <br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter[searchString] || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |-<br /> | filter[{FIELD_NAME}] || string || Reffers to the field that the retrieved date is orderd by || Possible values: ASC, DESC<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10758 2013-07-22T13:10:56Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10755 2013-07-22T11:21:25Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array,&lt;br /&gt; the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10754 2013-07-22T11:20:36Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array, the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10753 2013-07-22T11:19:58Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || - || The object root (will not be literaly be used in the coding).&lt;br /&gt;Used only here to describe the container for the actual properties.<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array, the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10752 2013-07-22T11:19:13Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || The object root (will not be literaly be used in the coding).&lt;br /&gt;Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || - || To describe a generic object element of the array, the refference to it's root is &quot;list[]&quot;<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10751 2013-07-22T11:18:50Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || The object root (will not be literaly be used in the coding).&lt;br /&gt;Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object array || - || YES || - || To describe a generic object element of the array, the refference to it's root is &quot;list[]&quot; || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10750 2013-07-22T11:15:44Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || The object root (will not be literaly be used in the coding).&lt;br /&gt;Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object(Build DTO) array || - || YES || - || The list of Build DTOs within the given limit || Reffer to Build DTO for object description<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#FF9900&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10749 2013-07-22T11:14:40Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application.<br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || The object root (will not be literaly be used in the coding).&lt;br /&gt;Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object(Build DTO) array || - || YES || - || The list of Build DTOs within the given limit || Reffer to Build DTO for object description<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10748 2013-07-22T11:13:13Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application. If <br /> |}<br /> <br /> === Response ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object(Build DTO) array || - || YES || - || The list of Build DTOs within the given limit || Reffer to Build DTO for object description<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list[]&lt;/span&gt;.&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10747 2013-07-22T11:02:48Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Description !! Comments<br /> |-<br /> | limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | offset || number || Represents the position of the first record in the page || If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id<br /> |-<br /> | filter || string || Consists of a string used to filter results || Generic parameter sent from front-end application. If <br /> |}<br /> <br /> === Responses ===<br /> <br /> If the &quot;limit&quot; parameter has the value 1, the information retrieved from this endpoint consists of a single object (Builds DTO).<br /> <br /> ==== Build DTO ====<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s) || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}<br /> <br /> <br /> ==== Returning Multiple Builds ====<br /> <br /> If the &quot;limit&quot; parameter is greater than 1 then the information retrieved from this endpoint consists of an object that has two properties: count (the total amount of items for pagination purposes)and the actual list of builds (objects with same structure as the Build DTO explained earlier).<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;count&lt;/span&gt; || number || - || YES || - || Total amount of builds || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;list&lt;/span&gt; || object(Build DTO) array || - || YES || - || The list of Build DTOs within the given limit || Reffer to Build DTO for object description<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10742 2013-07-19T09:46:13Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || Returns the total amount of builds from the data base || -<br /> |-<br /> | 3 || GET || /builds/{id} || JSON || Returns single build from the data base according to it's id || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Type !! Description !! Comments<br /> |-<br /> | 1 || limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || number || Represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || string || Consists of a string used to filter results || -<br /> |-<br /> | 3 || id || number || Path parameter that passes the build id || -<br /> |}<br /> <br /> === Responses ===<br /> <br /> ==== Endpoint 1 ( /builds ) ====<br /> <br /> The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || Object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || The name of the build target(s || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || The selected hardware || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings thrown by the build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || The extensions of the root file systems produced by the build || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10741 2013-07-19T09:41:26Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || Returns the total amount of builds from the data base || -<br /> |-<br /> | 3 || GET || /builds/{id} || JSON || Returns single build from the data base according to it's id || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Type !! Description !! Comments<br /> |-<br /> | 1 || limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || number || Represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || string || Consists of a string used to filter results || -<br /> |-<br /> | 3 || id || number || Path parameter that passes the build id || -<br /> |}<br /> <br /> === Responses ===<br /> <br /> ==== Endpoint 1 ( /builds ) ====<br /> <br /> The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || Object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed,&lt;br /&gt; 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || Output package types || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10740 2013-07-19T09:40:58Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || Returns the total amount of builds from the data base || -<br /> |-<br /> | 3 || GET || /builds/{id} || JSON || Returns single build from the data base according to it's id || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Type !! Description !! Comments<br /> |-<br /> | 1 || limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || number || Represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || string || Consists of a string used to filter results || -<br /> |-<br /> | 3 || id || number || Path parameter that passes the build id || -<br /> |}<br /> <br /> === Responses ===<br /> <br /> ==== Endpoint 1 ( /builds ) ====<br /> <br /> The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || Object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed, 1 - successful build<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || Output package types || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10739 2013-07-19T09:39:18Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || Returns the total amount of builds from the data base || -<br /> |-<br /> | 3 || GET || /builds/{id} || JSON || Returns single build from the data base according to it's id || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Type !! Description !! Comments<br /> |-<br /> | 1 || limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || number || Represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || string || Consists of a string used to filter results || -<br /> |-<br /> | 3 || id || number || Path parameter that passes the build id || -<br /> |}<br /> <br /> === Responses ===<br /> <br /> ==== Endpoint 1 ( /builds ) ====<br /> <br /> The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || Object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span style=&quot;color:#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || Output package types || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10738 2013-07-19T09:37:01Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || Returns the total amount of builds from the data base || -<br /> |-<br /> | 3 || GET || /builds/{id} || JSON || Returns single build from the data base according to it's id || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Type !! Description !! Comments<br /> |-<br /> | 1 || limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || number || Represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || string || Consists of a string used to filter results || -<br /> |-<br /> | 3 || id || number || Path parameter that passes the build id || -<br /> |}<br /> <br /> === Responses ===<br /> <br /> ==== Endpoint 1 ( /builds ) ====<br /> <br /> The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || Object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;outcome&lt;/span&gt; || number || 2 || YES || - || Signals successful or failed build || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;machine&lt;/span&gt; || string array || - || YES || - || - || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;startedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is started || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;completedOn&lt;/span&gt; || number representation of date || - || YES || - || Marks the moment the process is completed || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;errors&lt;/span&gt; || number || - || YES || - || Number of errors || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;warnings&lt;/span&gt; || number || - || YES || - || Number of warnings || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;log&lt;/span&gt; || string || - || YES || - || Path to log file || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;output&lt;/span&gt; || string array || - || YES || - || Output package types || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10737 2013-07-19T09:19:15Z

<p>Ciprian Pratia: This contract describes the way lists of builds or single builds are supplied to the interface.</p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || Returns the total amount of builds from the data base || -<br /> |-<br /> | 3 || GET || /builds/{id} || JSON || Returns single build from the data base according to it's id || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Type !! Description !! Comments<br /> |-<br /> | 1 || limit || number || The amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || number || Represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || string || Consists of a string used to filter results || -<br /> |-<br /> | 3 || id || number || Path parameter that passes the build id || -<br /> |}<br /> <br /> === Responses ===<br /> <br /> ==== Endpoint 1 ( /builds ) ====<br /> <br /> The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments<br /> |-<br /> | [Object Root] || Object || - || YES || - || The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;outcome&lt;/span&gt; || boolean || - || YES || - || Signals successful or failed build || -<br /> |-<br /> | [Object Root].&lt;span color=&quot;#006600&quot;&gt;target&lt;/span&gt; || string || - || YES || - || - || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10736 2013-07-19T08:37:49Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || returns the total amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Description !! Comments<br /> |-<br /> | 1 || limit || the amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || consists of a string used to filter results || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10735 2013-07-19T08:37:28Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || returns the total amount of builds from the data base || -<br /> |}<br /> <br /> === Parameters ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Affected Endpoint !! Name !! Description !! Comments<br /> |-<br /> | 1 || limit || the amout of builds to be displayed in one page || -<br /> |-<br /> | 1 || offset || represents the position of the first record in the page || -<br /> |-<br /> | 1 || filter || consists of a string used to filter results<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Category:REST_API_Contracts&diff=10734 2013-07-19T08:15:59Z

<p>Ciprian Pratia: </p> <hr /> <div>This category contains the REST contracts between WebHob Front End and Back End projects</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Category:REST_API_Contracts&diff=10733 2013-07-19T08:15:42Z

<p>Ciprian Pratia: </p> <hr /> <div>This category contains the REST contracts between WebHob Front End and Back End projects<br /> <br /> == Builds ==<br /> <br /> [[ Builds]]</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Build&diff=10732 2013-07-19T08:15:27Z

<p>Ciprian Pratia: moved Build to Builds</p> <hr /> <div>#REDIRECT [[Builds]]</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10731 2013-07-19T08:15:27Z

<p>Ciprian Pratia: moved Build to Builds</p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || returns the total amount of builds from the data base || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10730 2013-07-19T08:15:15Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || returns the total amount of builds from the data base || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10729 2013-07-19T08:14:39Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:REST API Contracts]]<br /> == Builds ==<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || returns the total amount of builds from the data base || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&diff=10728 2013-07-19T08:12:05Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:WebHob]]<br /> WebHob is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.<br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> Project planning is available below, are the design documents we follow.<br /> <br /> == User interface ==<br /> The design of the user interface takes place in iterations, and most recent designs supersede older ones. <br /> Here is a set of links to design documentation.<br /> * [[Web_Hob_design_project_with_T%26T]] - the latest user interface design<br /> * [[Visualisations]] - an inventory of data visualisations we aim to include in the first release of Web Hob<br /> * [[File:Multiuser_support_in_Web_Hob.pdf]] - different design approaches to handle multi-user scenarios<br /> * [[File:Web_Hob_content_structure.pdf]] - Web Hob information architecture<br /> <br /> <br /> <br /> === WebHob clickable prototype ===<br /> * [http://www.yoctoproject.org/webhob/phase3_final_web_prototype/dashboard.html A web-based prototype of the Web Hob user interface]<br /> <br /> <br /> <br /> === Old design documents ===<br /> * [[WebHob_Design]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> <br /> <br /> == Project Planning ==<br /> <br /> We plan to develop WebHob functionality in stages. Each stage should match with an Yocto Project release.<br /> <br /> === YP 1.5 release ===<br /> <br /> * WebHob will offer features to record and analyze bitbake runs, where a bitbake run is an invocation of bitbake to a certain target.<br /> * WebHob will offer ways to inspect the system image contents generated by running a Poky target that results in a disk image.<br /> <br /> [[https://bugzilla.yoctoproject.org/buglist.cgi?list_id=38454&amp;bug_severity=enhancement&amp;query_format=advanced&amp;bug_status=NEW&amp;bug_status=ACCEPTED&amp;bug_status=IN%20PROGRESS%20DESIGN&amp;bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&amp;bug_status=IN%20PROGRESS%20IMPLEMENTATION&amp;bug_status=IN%20PROGRESS%20REVIEW&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=WaitForUpstream&amp;component=web-hob&amp;target_milestone=1.5&amp;target_milestone=1.5%20M1&amp;target_milestone=1.5%20M2&amp;target_milestone=1.5%20M3&amp;target_milestone=1.5%20M4&amp;target_milestone=1.5%20M5&amp;product=Web%20-%20Hob WebHob Bugzilla feature list]] <br /> <br /> == Architecture and component design ==<br /> <br /> <br /> We are planning the capabilities of WebHob based on evolutive stages of implementation, using community feedback on each stage to plan, design and implement a set of capabilities for the next stage.<br /> In the first stage, synchronized with the planning of Yocto 1.5, we'll implement a build analysis / image inspection module.<br /> <br /> WebHob is designed as a collection of components that will run independently performing isolated functions. The interfaces between components are documented on this wiki as to ease interoperability with newer components. From design phase, we've taken care to account for further expansion needs, and account for scalability problems.<br /> <br /> * [[ WebHob general architecture ]]<br /> <br /> * [[ Data store investigation results and choices ]]<br /> <br /> * [[ WebHob source code repository details ]]<br /> <br /> * [[ Django models ]]<br /> <br /> * [[:Category :REST API Contracts| REST API Contracts]]<br /> <br /> == Installation and Running ==<br /> <br /> <br /> To get it up and running:<br /> <br /> * prerequisites: TCP ports 8000 for web interface, and 8200 for the bitbake xmlrpc interface<br /> <br /> * checkout the poky tree. currently http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=webhob-poky/master<br /> * set up a build as normal: &lt;code&gt; source poky/oe-init-build-env &lt;/code&gt;<br /> * at this point edit local.conf, or layers, etc.<br /> * start webhob system: &lt;code&gt; source webhob start &lt;/code&gt;<br /> * run builds normally: &lt;code&gt; bitbake mc &lt;/code&gt;<br /> * to stop webhob: &lt;code&gt; source webhob stop &lt;/code&gt;<br /> * to see the web interface: &lt;code&gt; xdg-open http://localhost:8000/ &lt;/code&gt;<br /> <br /> A bunch of files are created and used under the build/ directory:<br /> * webhob.sqlite - the database file<br /> * whbmain.log - the log file of the web server<br /> * whbmain.pid - contains the pid of the web server<br /> * dsi.pid - contains the pid of the DSI data bridge<br /> * bitbake-cookerdaemon.log - the log file of the bitbake server<br /> <br /> <br /> <br /> For more details, including how it runs, see [[ A manual for installation and running WebHob ]].<br /> <br /> == Testing ==<br /> Documentation and results related to WebHob Quality Assurance.<br /> <br /> * [[ WebHob testing plan ]]<br /> <br /> === QA Reports and Bugzilla entries ===<br /> <br /> == Old page content ==<br /> <br /> This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project. <br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> There have been 2 main pieces of work related to Web Hob so far:<br /> <br /> * [[Web Hob design project with T&amp;T|A design project with the London-based agency Tobias &amp; Tobias]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> === Web Hob information architecture ===<br /> <br /> This document represents the content structure of the Web Hob application.<br /> <br /> [[File:Web_Hob_content_structure.pdf]]<br /> <br /> === Different approaches to multi-user workflows ===<br /> <br /> This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob. <br /> <br /> * [[File:Multiuser_support_in_Web_Hob.pdf]]<br /> <br /> === Visualisations index ===<br /> <br /> The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&diff=10727 2013-07-19T08:11:47Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:WebHob]]<br /> WebHob is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.<br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> Project planning is available below, are the design documents we follow.<br /> <br /> == User interface ==<br /> The design of the user interface takes place in iterations, and most recent designs supersede older ones. <br /> Here is a set of links to design documentation.<br /> * [[Web_Hob_design_project_with_T%26T]] - the latest user interface design<br /> * [[Visualisations]] - an inventory of data visualisations we aim to include in the first release of Web Hob<br /> * [[File:Multiuser_support_in_Web_Hob.pdf]] - different design approaches to handle multi-user scenarios<br /> * [[File:Web_Hob_content_structure.pdf]] - Web Hob information architecture<br /> <br /> <br /> <br /> === WebHob clickable prototype ===<br /> * [http://www.yoctoproject.org/webhob/phase3_final_web_prototype/dashboard.html A web-based prototype of the Web Hob user interface]<br /> <br /> <br /> <br /> === Old design documents ===<br /> * [[WebHob_Design]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> <br /> <br /> == Project Planning ==<br /> <br /> We plan to develop WebHob functionality in stages. Each stage should match with an Yocto Project release.<br /> <br /> === YP 1.5 release ===<br /> <br /> * WebHob will offer features to record and analyze bitbake runs, where a bitbake run is an invocation of bitbake to a certain target.<br /> * WebHob will offer ways to inspect the system image contents generated by running a Poky target that results in a disk image.<br /> <br /> [[https://bugzilla.yoctoproject.org/buglist.cgi?list_id=38454&amp;bug_severity=enhancement&amp;query_format=advanced&amp;bug_status=NEW&amp;bug_status=ACCEPTED&amp;bug_status=IN%20PROGRESS%20DESIGN&amp;bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&amp;bug_status=IN%20PROGRESS%20IMPLEMENTATION&amp;bug_status=IN%20PROGRESS%20REVIEW&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=WaitForUpstream&amp;component=web-hob&amp;target_milestone=1.5&amp;target_milestone=1.5%20M1&amp;target_milestone=1.5%20M2&amp;target_milestone=1.5%20M3&amp;target_milestone=1.5%20M4&amp;target_milestone=1.5%20M5&amp;product=Web%20-%20Hob WebHob Bugzilla feature list]] <br /> <br /> == Architecture and component design ==<br /> <br /> <br /> We are planning the capabilities of WebHob based on evolutive stages of implementation, using community feedback on each stage to plan, design and implement a set of capabilities for the next stage.<br /> In the first stage, synchronized with the planning of Yocto 1.5, we'll implement a build analysis / image inspection module.<br /> <br /> WebHob is designed as a collection of components that will run independently performing isolated functions. The interfaces between components are documented on this wiki as to ease interoperability with newer components. From design phase, we've taken care to account for further expansion needs, and account for scalability problems.<br /> <br /> * [[ WebHob general architecture ]]<br /> <br /> * [[ Data store investigation results and choices ]]<br /> <br /> * [[ WebHob source code repository details ]]<br /> <br /> * [[ Django models ]]<br /> <br /> * [[ :Category: REST API Contracts| REST API Contracts]]<br /> <br /> == Installation and Running ==<br /> <br /> <br /> To get it up and running:<br /> <br /> * prerequisites: TCP ports 8000 for web interface, and 8200 for the bitbake xmlrpc interface<br /> <br /> * checkout the poky tree. currently http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=webhob-poky/master<br /> * set up a build as normal: &lt;code&gt; source poky/oe-init-build-env &lt;/code&gt;<br /> * at this point edit local.conf, or layers, etc.<br /> * start webhob system: &lt;code&gt; source webhob start &lt;/code&gt;<br /> * run builds normally: &lt;code&gt; bitbake mc &lt;/code&gt;<br /> * to stop webhob: &lt;code&gt; source webhob stop &lt;/code&gt;<br /> * to see the web interface: &lt;code&gt; xdg-open http://localhost:8000/ &lt;/code&gt;<br /> <br /> A bunch of files are created and used under the build/ directory:<br /> * webhob.sqlite - the database file<br /> * whbmain.log - the log file of the web server<br /> * whbmain.pid - contains the pid of the web server<br /> * dsi.pid - contains the pid of the DSI data bridge<br /> * bitbake-cookerdaemon.log - the log file of the bitbake server<br /> <br /> <br /> <br /> For more details, including how it runs, see [[ A manual for installation and running WebHob ]].<br /> <br /> == Testing ==<br /> Documentation and results related to WebHob Quality Assurance.<br /> <br /> * [[ WebHob testing plan ]]<br /> <br /> === QA Reports and Bugzilla entries ===<br /> <br /> == Old page content ==<br /> <br /> This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project. <br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> There have been 2 main pieces of work related to Web Hob so far:<br /> <br /> * [[Web Hob design project with T&amp;T|A design project with the London-based agency Tobias &amp; Tobias]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> === Web Hob information architecture ===<br /> <br /> This document represents the content structure of the Web Hob application.<br /> <br /> [[File:Web_Hob_content_structure.pdf]]<br /> <br /> === Different approaches to multi-user workflows ===<br /> <br /> This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob. <br /> <br /> * [[File:Multiuser_support_in_Web_Hob.pdf]]<br /> <br /> === Visualisations index ===<br /> <br /> The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&diff=10726 2013-07-19T08:11:29Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:WebHob]]<br /> WebHob is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.<br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> Project planning is available below, are the design documents we follow.<br /> <br /> == User interface ==<br /> The design of the user interface takes place in iterations, and most recent designs supersede older ones. <br /> Here is a set of links to design documentation.<br /> * [[Web_Hob_design_project_with_T%26T]] - the latest user interface design<br /> * [[Visualisations]] - an inventory of data visualisations we aim to include in the first release of Web Hob<br /> * [[File:Multiuser_support_in_Web_Hob.pdf]] - different design approaches to handle multi-user scenarios<br /> * [[File:Web_Hob_content_structure.pdf]] - Web Hob information architecture<br /> <br /> <br /> <br /> === WebHob clickable prototype ===<br /> * [http://www.yoctoproject.org/webhob/phase3_final_web_prototype/dashboard.html A web-based prototype of the Web Hob user interface]<br /> <br /> <br /> <br /> === Old design documents ===<br /> * [[WebHob_Design]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> <br /> <br /> == Project Planning ==<br /> <br /> We plan to develop WebHob functionality in stages. Each stage should match with an Yocto Project release.<br /> <br /> === YP 1.5 release ===<br /> <br /> * WebHob will offer features to record and analyze bitbake runs, where a bitbake run is an invocation of bitbake to a certain target.<br /> * WebHob will offer ways to inspect the system image contents generated by running a Poky target that results in a disk image.<br /> <br /> [[https://bugzilla.yoctoproject.org/buglist.cgi?list_id=38454&amp;bug_severity=enhancement&amp;query_format=advanced&amp;bug_status=NEW&amp;bug_status=ACCEPTED&amp;bug_status=IN%20PROGRESS%20DESIGN&amp;bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&amp;bug_status=IN%20PROGRESS%20IMPLEMENTATION&amp;bug_status=IN%20PROGRESS%20REVIEW&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=WaitForUpstream&amp;component=web-hob&amp;target_milestone=1.5&amp;target_milestone=1.5%20M1&amp;target_milestone=1.5%20M2&amp;target_milestone=1.5%20M3&amp;target_milestone=1.5%20M4&amp;target_milestone=1.5%20M5&amp;product=Web%20-%20Hob WebHob Bugzilla feature list]] <br /> <br /> == Architecture and component design ==<br /> <br /> <br /> We are planning the capabilities of WebHob based on evolutive stages of implementation, using community feedback on each stage to plan, design and implement a set of capabilities for the next stage.<br /> In the first stage, synchronized with the planning of Yocto 1.5, we'll implement a build analysis / image inspection module.<br /> <br /> WebHob is designed as a collection of components that will run independently performing isolated functions. The interfaces between components are documented on this wiki as to ease interoperability with newer components. From design phase, we've taken care to account for further expansion needs, and account for scalability problems.<br /> <br /> * [[ WebHob general architecture ]]<br /> <br /> * [[ Data store investigation results and choices ]]<br /> <br /> * [[ WebHob source code repository details ]]<br /> <br /> * [[ Django models ]]<br /> <br /> * [[ :Category:REST API Contracts| REST API Contracts]]<br /> <br /> == Installation and Running ==<br /> <br /> <br /> To get it up and running:<br /> <br /> * prerequisites: TCP ports 8000 for web interface, and 8200 for the bitbake xmlrpc interface<br /> <br /> * checkout the poky tree. currently http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=webhob-poky/master<br /> * set up a build as normal: &lt;code&gt; source poky/oe-init-build-env &lt;/code&gt;<br /> * at this point edit local.conf, or layers, etc.<br /> * start webhob system: &lt;code&gt; source webhob start &lt;/code&gt;<br /> * run builds normally: &lt;code&gt; bitbake mc &lt;/code&gt;<br /> * to stop webhob: &lt;code&gt; source webhob stop &lt;/code&gt;<br /> * to see the web interface: &lt;code&gt; xdg-open http://localhost:8000/ &lt;/code&gt;<br /> <br /> A bunch of files are created and used under the build/ directory:<br /> * webhob.sqlite - the database file<br /> * whbmain.log - the log file of the web server<br /> * whbmain.pid - contains the pid of the web server<br /> * dsi.pid - contains the pid of the DSI data bridge<br /> * bitbake-cookerdaemon.log - the log file of the bitbake server<br /> <br /> <br /> <br /> For more details, including how it runs, see [[ A manual for installation and running WebHob ]].<br /> <br /> == Testing ==<br /> Documentation and results related to WebHob Quality Assurance.<br /> <br /> * [[ WebHob testing plan ]]<br /> <br /> === QA Reports and Bugzilla entries ===<br /> <br /> == Old page content ==<br /> <br /> This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project. <br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> There have been 2 main pieces of work related to Web Hob so far:<br /> <br /> * [[Web Hob design project with T&amp;T|A design project with the London-based agency Tobias &amp; Tobias]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> === Web Hob information architecture ===<br /> <br /> This document represents the content structure of the Web Hob application.<br /> <br /> [[File:Web_Hob_content_structure.pdf]]<br /> <br /> === Different approaches to multi-user workflows ===<br /> <br /> This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob. <br /> <br /> * [[File:Multiuser_support_in_Web_Hob.pdf]]<br /> <br /> === Visualisations index ===<br /> <br /> The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Analysis_REST_API_Contracts&diff=10725 2013-07-19T08:10:57Z

<p>Ciprian Pratia: Blanked the page</p> <hr /> <div></div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&diff=10724 2013-07-19T08:09:20Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:WebHob]]<br /> WebHob is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.<br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> Project planning is available below, are the design documents we follow.<br /> <br /> == User interface ==<br /> The design of the user interface takes place in iterations, and most recent designs supersede older ones. <br /> Here is a set of links to design documentation.<br /> * [[Web_Hob_design_project_with_T%26T]] - the latest user interface design<br /> * [[Visualisations]] - an inventory of data visualisations we aim to include in the first release of Web Hob<br /> * [[File:Multiuser_support_in_Web_Hob.pdf]] - different design approaches to handle multi-user scenarios<br /> * [[File:Web_Hob_content_structure.pdf]] - Web Hob information architecture<br /> <br /> <br /> <br /> === WebHob clickable prototype ===<br /> * [http://www.yoctoproject.org/webhob/phase3_final_web_prototype/dashboard.html A web-based prototype of the Web Hob user interface]<br /> <br /> <br /> <br /> === Old design documents ===<br /> * [[WebHob_Design]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> <br /> <br /> == Project Planning ==<br /> <br /> We plan to develop WebHob functionality in stages. Each stage should match with an Yocto Project release.<br /> <br /> === YP 1.5 release ===<br /> <br /> * WebHob will offer features to record and analyze bitbake runs, where a bitbake run is an invocation of bitbake to a certain target.<br /> * WebHob will offer ways to inspect the system image contents generated by running a Poky target that results in a disk image.<br /> <br /> [[https://bugzilla.yoctoproject.org/buglist.cgi?list_id=38454&amp;bug_severity=enhancement&amp;query_format=advanced&amp;bug_status=NEW&amp;bug_status=ACCEPTED&amp;bug_status=IN%20PROGRESS%20DESIGN&amp;bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&amp;bug_status=IN%20PROGRESS%20IMPLEMENTATION&amp;bug_status=IN%20PROGRESS%20REVIEW&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=WaitForUpstream&amp;component=web-hob&amp;target_milestone=1.5&amp;target_milestone=1.5%20M1&amp;target_milestone=1.5%20M2&amp;target_milestone=1.5%20M3&amp;target_milestone=1.5%20M4&amp;target_milestone=1.5%20M5&amp;product=Web%20-%20Hob WebHob Bugzilla feature list]] <br /> <br /> == Architecture and component design ==<br /> <br /> <br /> We are planning the capabilities of WebHob based on evolutive stages of implementation, using community feedback on each stage to plan, design and implement a set of capabilities for the next stage.<br /> In the first stage, synchronized with the planning of Yocto 1.5, we'll implement a build analysis / image inspection module.<br /> <br /> WebHob is designed as a collection of components that will run independently performing isolated functions. The interfaces between components are documented on this wiki as to ease interoperability with newer components. From design phase, we've taken care to account for further expansion needs, and account for scalability problems.<br /> <br /> * [[ WebHob general architecture ]]<br /> <br /> * [[ Data store investigation results and choices ]]<br /> <br /> * [[ WebHob source code repository details ]]<br /> <br /> * [[ Django models ]]<br /> <br /> * [[ REST API Contracts ]]<br /> <br /> == Installation and Running ==<br /> <br /> <br /> To get it up and running:<br /> <br /> * prerequisites: TCP ports 8000 for web interface, and 8200 for the bitbake xmlrpc interface<br /> <br /> * checkout the poky tree. currently http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=webhob-poky/master<br /> * set up a build as normal: &lt;code&gt; source poky/oe-init-build-env &lt;/code&gt;<br /> * at this point edit local.conf, or layers, etc.<br /> * start webhob system: &lt;code&gt; source webhob start &lt;/code&gt;<br /> * run builds normally: &lt;code&gt; bitbake mc &lt;/code&gt;<br /> * to stop webhob: &lt;code&gt; source webhob stop &lt;/code&gt;<br /> * to see the web interface: &lt;code&gt; xdg-open http://localhost:8000/ &lt;/code&gt;<br /> <br /> A bunch of files are created and used under the build/ directory:<br /> * webhob.sqlite - the database file<br /> * whbmain.log - the log file of the web server<br /> * whbmain.pid - contains the pid of the web server<br /> * dsi.pid - contains the pid of the DSI data bridge<br /> * bitbake-cookerdaemon.log - the log file of the bitbake server<br /> <br /> <br /> <br /> For more details, including how it runs, see [[ A manual for installation and running WebHob ]].<br /> <br /> == Testing ==<br /> Documentation and results related to WebHob Quality Assurance.<br /> <br /> * [[ WebHob testing plan ]]<br /> <br /> === QA Reports and Bugzilla entries ===<br /> <br /> == Old page content ==<br /> <br /> This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project. <br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> There have been 2 main pieces of work related to Web Hob so far:<br /> <br /> * [[Web Hob design project with T&amp;T|A design project with the London-based agency Tobias &amp; Tobias]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> === Web Hob information architecture ===<br /> <br /> This document represents the content structure of the Web Hob application.<br /> <br /> [[File:Web_Hob_content_structure.pdf]]<br /> <br /> === Different approaches to multi-user workflows ===<br /> <br /> This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob. <br /> <br /> * [[File:Multiuser_support_in_Web_Hob.pdf]]<br /> <br /> === Visualisations index ===<br /> <br /> The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&diff=10723 2013-07-19T08:08:02Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:WebHob]]<br /> WebHob is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.<br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> Project planning is available below, are the design documents we follow.<br /> <br /> == User interface ==<br /> The design of the user interface takes place in iterations, and most recent designs supersede older ones. <br /> Here is a set of links to design documentation.<br /> * [[Web_Hob_design_project_with_T%26T]] - the latest user interface design<br /> * [[Visualisations]] - an inventory of data visualisations we aim to include in the first release of Web Hob<br /> * [[File:Multiuser_support_in_Web_Hob.pdf]] - different design approaches to handle multi-user scenarios<br /> * [[File:Web_Hob_content_structure.pdf]] - Web Hob information architecture<br /> <br /> <br /> <br /> === WebHob clickable prototype ===<br /> * [http://www.yoctoproject.org/webhob/phase3_final_web_prototype/dashboard.html A web-based prototype of the Web Hob user interface]<br /> <br /> <br /> <br /> === Old design documents ===<br /> * [[WebHob_Design]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> <br /> <br /> == Project Planning ==<br /> <br /> We plan to develop WebHob functionality in stages. Each stage should match with an Yocto Project release.<br /> <br /> === YP 1.5 release ===<br /> <br /> * WebHob will offer features to record and analyze bitbake runs, where a bitbake run is an invocation of bitbake to a certain target.<br /> * WebHob will offer ways to inspect the system image contents generated by running a Poky target that results in a disk image.<br /> <br /> [[https://bugzilla.yoctoproject.org/buglist.cgi?list_id=38454&amp;bug_severity=enhancement&amp;query_format=advanced&amp;bug_status=NEW&amp;bug_status=ACCEPTED&amp;bug_status=IN%20PROGRESS%20DESIGN&amp;bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&amp;bug_status=IN%20PROGRESS%20IMPLEMENTATION&amp;bug_status=IN%20PROGRESS%20REVIEW&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=WaitForUpstream&amp;component=web-hob&amp;target_milestone=1.5&amp;target_milestone=1.5%20M1&amp;target_milestone=1.5%20M2&amp;target_milestone=1.5%20M3&amp;target_milestone=1.5%20M4&amp;target_milestone=1.5%20M5&amp;product=Web%20-%20Hob WebHob Bugzilla feature list]] <br /> <br /> == Architecture and component design ==<br /> <br /> <br /> We are planning the capabilities of WebHob based on evolutive stages of implementation, using community feedback on each stage to plan, design and implement a set of capabilities for the next stage.<br /> In the first stage, synchronized with the planning of Yocto 1.5, we'll implement a build analysis / image inspection module.<br /> <br /> WebHob is designed as a collection of components that will run independently performing isolated functions. The interfaces between components are documented on this wiki as to ease interoperability with newer components. From design phase, we've taken care to account for further expansion needs, and account for scalability problems.<br /> <br /> * [[ WebHob general architecture ]]<br /> <br /> * [[ Data store investigation results and choices ]]<br /> <br /> * [[ WebHob source code repository details ]]<br /> <br /> * [[ Django models ]]<br /> <br /> * [[Category:REST API Contracts ]]<br /> <br /> == Installation and Running ==<br /> <br /> <br /> To get it up and running:<br /> <br /> * prerequisites: TCP ports 8000 for web interface, and 8200 for the bitbake xmlrpc interface<br /> <br /> * checkout the poky tree. currently http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=webhob-poky/master<br /> * set up a build as normal: &lt;code&gt; source poky/oe-init-build-env &lt;/code&gt;<br /> * at this point edit local.conf, or layers, etc.<br /> * start webhob system: &lt;code&gt; source webhob start &lt;/code&gt;<br /> * run builds normally: &lt;code&gt; bitbake mc &lt;/code&gt;<br /> * to stop webhob: &lt;code&gt; source webhob stop &lt;/code&gt;<br /> * to see the web interface: &lt;code&gt; xdg-open http://localhost:8000/ &lt;/code&gt;<br /> <br /> A bunch of files are created and used under the build/ directory:<br /> * webhob.sqlite - the database file<br /> * whbmain.log - the log file of the web server<br /> * whbmain.pid - contains the pid of the web server<br /> * dsi.pid - contains the pid of the DSI data bridge<br /> * bitbake-cookerdaemon.log - the log file of the bitbake server<br /> <br /> <br /> <br /> For more details, including how it runs, see [[ A manual for installation and running WebHob ]].<br /> <br /> == Testing ==<br /> Documentation and results related to WebHob Quality Assurance.<br /> <br /> * [[ WebHob testing plan ]]<br /> <br /> === QA Reports and Bugzilla entries ===<br /> <br /> == Old page content ==<br /> <br /> This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project. <br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> There have been 2 main pieces of work related to Web Hob so far:<br /> <br /> * [[Web Hob design project with T&amp;T|A design project with the London-based agency Tobias &amp; Tobias]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> === Web Hob information architecture ===<br /> <br /> This document represents the content structure of the Web Hob application.<br /> <br /> [[File:Web_Hob_content_structure.pdf]]<br /> <br /> === Different approaches to multi-user workflows ===<br /> <br /> This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob. <br /> <br /> * [[File:Multiuser_support_in_Web_Hob.pdf]]<br /> <br /> === Visualisations index ===<br /> <br /> The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Toaster&diff=10722 2013-07-19T08:07:04Z

<p>Ciprian Pratia: </p> <hr /> <div>[[Category:WebHob]]<br /> WebHob is a Web-based interface to the Bitbake build system and the Poky distribution inside the Yocto Project.<br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> Project planning is available below, are the design documents we follow.<br /> <br /> == User interface ==<br /> The design of the user interface takes place in iterations, and most recent designs supersede older ones. <br /> Here is a set of links to design documentation.<br /> * [[Web_Hob_design_project_with_T%26T]] - the latest user interface design<br /> * [[Visualisations]] - an inventory of data visualisations we aim to include in the first release of Web Hob<br /> * [[File:Multiuser_support_in_Web_Hob.pdf]] - different design approaches to handle multi-user scenarios<br /> * [[File:Web_Hob_content_structure.pdf]] - Web Hob information architecture<br /> <br /> <br /> <br /> === WebHob clickable prototype ===<br /> * [http://www.yoctoproject.org/webhob/phase3_final_web_prototype/dashboard.html A web-based prototype of the Web Hob user interface]<br /> <br /> <br /> <br /> === Old design documents ===<br /> * [[WebHob_Design]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> <br /> <br /> == Project Planning ==<br /> <br /> We plan to develop WebHob functionality in stages. Each stage should match with an Yocto Project release.<br /> <br /> === YP 1.5 release ===<br /> <br /> * WebHob will offer features to record and analyze bitbake runs, where a bitbake run is an invocation of bitbake to a certain target.<br /> * WebHob will offer ways to inspect the system image contents generated by running a Poky target that results in a disk image.<br /> <br /> [[https://bugzilla.yoctoproject.org/buglist.cgi?list_id=38454&amp;bug_severity=enhancement&amp;query_format=advanced&amp;bug_status=NEW&amp;bug_status=ACCEPTED&amp;bug_status=IN%20PROGRESS%20DESIGN&amp;bug_status=IN%20PROGRESS%20DESIGN%20COMPLETE&amp;bug_status=IN%20PROGRESS%20IMPLEMENTATION&amp;bug_status=IN%20PROGRESS%20REVIEW&amp;bug_status=REOPENED&amp;bug_status=NEEDINFO&amp;bug_status=WaitForUpstream&amp;component=web-hob&amp;target_milestone=1.5&amp;target_milestone=1.5%20M1&amp;target_milestone=1.5%20M2&amp;target_milestone=1.5%20M3&amp;target_milestone=1.5%20M4&amp;target_milestone=1.5%20M5&amp;product=Web%20-%20Hob WebHob Bugzilla feature list]] <br /> <br /> == Architecture and component design ==<br /> <br /> <br /> We are planning the capabilities of WebHob based on evolutive stages of implementation, using community feedback on each stage to plan, design and implement a set of capabilities for the next stage.<br /> In the first stage, synchronized with the planning of Yocto 1.5, we'll implement a build analysis / image inspection module.<br /> <br /> WebHob is designed as a collection of components that will run independently performing isolated functions. The interfaces between components are documented on this wiki as to ease interoperability with newer components. From design phase, we've taken care to account for further expansion needs, and account for scalability problems.<br /> <br /> * [[ WebHob general architecture ]]<br /> <br /> * [[ Data store investigation results and choices ]]<br /> <br /> * [[ WebHob source code repository details ]]<br /> <br /> * [[ Django models ]]<br /> <br /> * [[Category: REST API Contracts ]]<br /> <br /> == Installation and Running ==<br /> <br /> <br /> To get it up and running:<br /> <br /> * prerequisites: TCP ports 8000 for web interface, and 8200 for the bitbake xmlrpc interface<br /> <br /> * checkout the poky tree. currently http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=webhob-poky/master<br /> * set up a build as normal: &lt;code&gt; source poky/oe-init-build-env &lt;/code&gt;<br /> * at this point edit local.conf, or layers, etc.<br /> * start webhob system: &lt;code&gt; source webhob start &lt;/code&gt;<br /> * run builds normally: &lt;code&gt; bitbake mc &lt;/code&gt;<br /> * to stop webhob: &lt;code&gt; source webhob stop &lt;/code&gt;<br /> * to see the web interface: &lt;code&gt; xdg-open http://localhost:8000/ &lt;/code&gt;<br /> <br /> A bunch of files are created and used under the build/ directory:<br /> * webhob.sqlite - the database file<br /> * whbmain.log - the log file of the web server<br /> * whbmain.pid - contains the pid of the web server<br /> * dsi.pid - contains the pid of the DSI data bridge<br /> * bitbake-cookerdaemon.log - the log file of the bitbake server<br /> <br /> <br /> <br /> For more details, including how it runs, see [[ A manual for installation and running WebHob ]].<br /> <br /> == Testing ==<br /> Documentation and results related to WebHob Quality Assurance.<br /> <br /> * [[ WebHob testing plan ]]<br /> <br /> === QA Reports and Bugzilla entries ===<br /> <br /> == Old page content ==<br /> <br /> This page is about the Web Hob project. Web Hob is a web-based interface to the Yocto Project. <br /> <br /> General discussion about '''Web Hob''' happens on a dedicated mailing list: [https://lists.yoctoproject.org/listinfo/webhob https://lists.yoctoproject.org/listinfo/webhob]<br /> <br /> There have been 2 main pieces of work related to Web Hob so far:<br /> <br /> * [[Web Hob design project with T&amp;T|A design project with the London-based agency Tobias &amp; Tobias]]<br /> * [[Yocto Web Hob Design 0.0 — Archived|A preliminary design project]] by [http://www.jimkosem.com/ Jim Kosem]<br /> <br /> === Web Hob information architecture ===<br /> <br /> This document represents the content structure of the Web Hob application.<br /> <br /> [[File:Web_Hob_content_structure.pdf]]<br /> <br /> === Different approaches to multi-user workflows ===<br /> <br /> This document outlines the different approaches we have uncovered so far to facilitate multi-user and team work with Web Hob. <br /> <br /> * [[File:Multiuser_support_in_Web_Hob.pdf]]<br /> <br /> === Visualisations index ===<br /> <br /> The build analysis functionality in Web Hob will include several graphical presentations of build data. The first step to design them is [[visualisations |listing them all]].</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Webhob_REST_API_Builds&diff=10721 2013-07-19T08:04:47Z

<p>Ciprian Pratia: Created page with &quot;== Builds == === Endpoints === {| class=&quot;wikitable&quot; |- ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments |- | 1 || GET || /builds || JSON || returns page size limi...&quot;</p> <hr /> <div>== Builds ==<br /> <br /> === Endpoints ===<br /> <br /> {| class=&quot;wikitable&quot;<br /> |-<br /> ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments<br /> |-<br /> | 1 || GET || /builds || JSON || returns page size limited and search criteria filtered amount of builds from the data base || -<br /> |-<br /> | 2 || GET || /builds_count || JSON || returns the total amount of builds from the data base || -<br /> |}</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Category:REST_API_Contracts&diff=10720 2013-07-19T07:54:52Z

<p>Ciprian Pratia: </p> <hr /> <div>This category contains the REST contracts between WebHob Front End and Back End projects<br /> <br /> == Builds ==<br /> <br /> [[ Build ]]</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Category:REST_API_Contracts&diff=10719 2013-07-18T15:41:03Z

<p>Ciprian Pratia: </p> <hr /> <div>This category contains the REST contracts between WebHob Front End and Back End projects</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Category:REST_API_Contracts&diff=10718 2013-07-18T15:38:57Z

<p>Ciprian Pratia: </p> <hr /> <div>This category contains the REST contracts between WebHob Front End and Back End porjects</div>

Ciprian Pratia https://wiki.yoctoproject.org/wiki/index.php?title=Category:REST_API_Contracts&diff=10717 2013-07-18T15:37:44Z

<p>Ciprian Pratia: Created page with &quot;==REST API Contracts==&quot;</p> <hr /> <div>==REST API Contracts==</div>

Ciprian Pratia