Webhob REST API Builds: Difference between revisions
From Yocto Project
Jump to navigationJump to search
No edit summary |
(This contract describes the way lists of builds or single builds are supplied to the interface.) |
||
| Line 7: | Line 7: | ||
! Nr. !! Method !! Endpoint !! Body !! Description !! Comments | ! Nr. !! Method !! Endpoint !! Body !! Description !! Comments | ||
|- | |- | ||
| 1 || GET || /builds || JSON || | | 1 || GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || - | ||
|- | |- | ||
| 2 || GET || /builds_count || JSON || | | 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 || - | |||
|} | |} | ||
| Line 16: | Line 18: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Affected Endpoint !! Name !! Description !! Comments | ! 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 color="#006600">outcome</span> || boolean || - || YES || - || Signals successful or failed build || - | ||
|- | |- | ||
| | | [Object Root].<span color="#006600">target</span> || string || - || YES || - || - || - | ||
|} | |} | ||
Revision as of 09:19, 19 July 2013
Endpoints
| 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
| 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.
| 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].outcome | boolean | - | YES | - | Signals successful or failed build | - |
| [Object Root].target | string | - | YES | - | - | - |
