| Summary: | api: create final definition of webhob APIs | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Build System, Metadata & Runtime] Toaster | Reporter: | Alexandru Damian <alexandru.damian> | ||||
| Component: | toaster | Assignee: | Alexandru Damian <alexandru.damian> | ||||
| Status: | VERIFIED FIXED | QA Contact: | |||||
| Severity: | enhancement | ||||||
| Priority: | High | CC: | alexandru.c.georgescu, andreea.b.proca, belen.barros.pena, jessica.zhang | ||||
| Version: | 1.5 | ||||||
| Target Milestone: | 1.5 M4 | ||||||
| Hardware: | x86 | ||||||
| OS: | Multiple | ||||||
| Whiteboard: | |||||||
| OS type for building Yocto: | --- | Type of Regression: | --- | ||||
| Verified: | Documentation change: | Don't know | |||||
| Bug Depends on: | |||||||
| Bug Blocks: | 4948, 5016 | ||||||
| Attachments: |
|
||||||
|
Description
Alexandru Damian
2013-08-14 14:28:29 UTC
The REST API contracts are documented here. https://wiki.yoctoproject.org/wiki/REST_API_Contracts As of 15th August, this document supercedes all other REST API documents. The APIs for object retrieval have been defined. Please review the link above and let me know if there is something missing. The dependency data for Tasks, Recipes and Packages have to be defined. Final version of the REST API done. Please review and re-open this bug with specific comments regarding any missing info that would be needed in the frontend. Created attachment 1432 [details]
API review
Alex and Belen went through the API (see attached spreadsheet) and found that the following needs to be added: * output full file name (the full name of the files that constitute the outcome of the build) * full path to task script * task covered by (if possible) * errors content (we are already collecting this but we need an API call for it) * warnings content (we are already collecting this but we need an API call for it) * diffsigs command output * is package included in rootfs? * package files (location in disk of package files) * package license * package depends / recommends / brought in by * names of files generated by each package * size of files generated by each package The APIs updated https://wiki.yoctoproject.org/wiki/REST_API_Contracts Known missing features: > > * diffsigs command output * needs extensive re-working of the bitbake server protocol since we need to execute commands back on a remote server, which is not supported in Stage 1. Propose deferring. Apart from the(In reply to comment #6) > The APIs updated https://wiki.yoctoproject.org/wiki/REST_API_Contracts > > Known missing features: > > > > * diffsigs command output > > * needs extensive re-working of the bitbake server protocol since we need to > execute commands back on a remote server, which is not supported in Stage 1. > Propose deferring. Apart from the diffsigs command output (moved to 1.6), I am also missing the 'covered by' information for tasks, although AlexD has mentioned this can be obtained with a database query on the information we are already collecting. Verified. |