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