Analysis REST API Contracts
WebHob is accessible through REST APIs, which make the backend available to any client.
The data collected during the build is available on no-restrictions, anonymous, read-only API running on the local host machine.
General
The interface to retrieve objects is available as a search query returning a list of typed objects. The request method must be GET. The answers are always returned as JSON.
API version
The REST API is versioned as to allow further upgrades without having to maintain backward compatibility through changing the major version number. Minor version numbers are inteded to signify a capability level while maintaining compatibility.
This is the API version 1.0. All API requests are grouped under URL:
api/1.0/
Object types
The API can return Build, Task, Package, Layer, Layerversion, Recipe, Variable. Each object is described below.
Search operation
The primary operation of the API is to retrieve a set of objects from the backend based on a search operation. The result will also contain all the data for the objects being returned, as to avoid separate connections to further bring the objects of the type queried.
The search operation can also specify the ordering of the results by key.
The search parameters are the same for all object types.
Parameters =
| Name | Type | Description | Comments |
|---|---|---|---|
| limit | number | The number of objects to be returned | - |
| offset | number | Offset into the search result index. | - |
| search | string | Search string for all fields | The argument is the string to searched in the database. The backend MUST return only records that match the string. |
| filter | string | String used to specify result filter function | The general form: "<FIELD>:<VALUE>[,<FIELD>:<VALUE>]*". The backend MUST only return records that have FIELD matching to the VALUE specified. The <FIELD> names for each object type are the property names of the object. |
| orderby | string | the name of the field that determens the soring of the resuls. | "<FIELD>:<ORDER_DIRECTION>". The results are ordered by the <FIELD> values in the <ORDER_DIRECTION> order. <ORDER_DIRECTION> values may be "asc" or "desc". |
Build
Endpoints
| Method | Endpoint | Body | Description | Comments |
|---|---|---|---|---|
| GET | /builds | JSON | Returns page size limited and search criteria filtered amount of builds from the data base | - |
Response
| Name | Type | Dimension | Required | Default value(s) | Description | Comments |
|---|---|---|---|---|---|---|
| [Object Root] | object | - | YES | - | - | - |
| [Object Root].count | number | - | YES | - | Total amount of builds to be displayed (according to filter parameter) | - |
| [Object Root].list | object array | - | YES | - | - | To describe a generic object element of the array, the refference to it's root is "list[]" |
| [Object Root].list[].pk | number | - | YES | - | - | - |
| [Object Root].list[].model | string | - | YES | - | - | - |
| [Object Root].list[].fields | object | - | YES | - | - | - |
| [Object Root].list[].fields.outcome | number | 2 | YES | - | Signals successful or failed build | 0 - the build has failed, 1 - successful build |
| [Object Root].list[].fields.target | string | - | YES | - | The name of the build target(s) | - |
| [Object Root].list[].fields.machine | string array | - | YES | - | The selected hardware | - |
| [Object Root].list[].fields.started_on | number representation of date | - | YES | - | Marks the moment the process is started | - |
| [Object Root].list[].fields.completed_on | number representation of date | - | YES | - | Marks the moment the process is completed | - |
| [Object Root].list[].fields.errors_no | number | - | YES | - | Number of errors thrown by the build | - |
| [Object Root].list[].fields.warnings_no | number | - | YES | - | Number of warnings thrown by the build | - |
| [Object Root].list[].fields.cooker_log_path | string | - | YES | - | Path to log file | - |
| [Object Root].list[].fields.image_fstypes | string array | - | YES | - | The extensions of the root file systems produced by the build | - |
