|
|
| (24 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| [[Category:REST API Contracts]] | | Superceded by [[REST API Contracts]] |
| | |
| === Endpoints ===
| |
| | |
| {| class="wikitable"
| |
| |-
| |
| ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments
| |
| |-
| |
| | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -
| |
| |-
| |
| | 2 || GET || /builds_count || JSON || Returns the total amount of builds from the data base || -
| |
| |-
| |
| | 3 || GET || /builds/{id} || JSON || Returns single build from the data base according to it's id || -
| |
| |}
| |
| | |
| === Parameters ===
| |
| | |
| {| class="wikitable"
| |
| |-
| |
| ! Affected Endpoint !! Name !! Type !! Description !! Comments
| |
| |-
| |
| | 1 || limit || number || The amout of builds to be displayed in one page || -
| |
| |-
| |
| | 1 || offset || number || Represents the position of the first record in the page || -
| |
| |-
| |
| | 1 || filter || string || Consists of a string used to filter results || -
| |
| |-
| |
| | 3 || id || number || Path parameter that passes the build id || -
| |
| |}
| |
| | |
| === Responses ===
| |
| | |
| ==== Endpoint 1 ( /builds ) ====
| |
| | |
| The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.
| |
| | |
| {| class="wikitable"
| |
| |-
| |
| ! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
| |
| |-
| |
| | [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. || -
| |
| |-
| |
| | [Object Root].<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:#006600">target</span> || string || - || YES || - || The name of the build target(s || -
| |
| |-
| |
| | [Object Root].<span style="color:#006600">machine</span> || string array || - || YES || - || The selected hardware || -
| |
| |-
| |
| | [Object Root].<span style="color:#006600">startedOn</span> || number representation of date || - || YES || - || Marks the moment the process is started || -
| |
| |-
| |
| | [Object Root].<span style="color:#006600">completedOn</span> || number representation of date || - || YES || - || Marks the moment the process is completed || -
| |
| |-
| |
| | [Object Root].<span style="color:#006600">errors</span> || number || - || YES || - || Number of errors thrown by the build || -
| |
| |-
| |
| | [Object Root].<span style="color:#006600">warnings</span> || number || - || YES || - || Number of warnings thrown by the build || -
| |
| |-
| |
| | [Object Root].<span style="color:#006600">log</span> || string || - || YES || - || Path to log file || -
| |
| |-
| |
| | [Object Root].<span style="color:#006600">output</span> || string array || - || YES || - || The extensions of the root file systems produced by the build || -
| |
| |}
| |
