StealthOS/subiquity
StealthOS
/
subiquity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add a bit in DESIGN.md about how errors work in the API

This commit is contained in:
Michael Hudson-Doyle 2021-05-13 06:17:33 +12:00
parent f339620a50
commit 7a6a984578
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
DESIGN.md
View File

@ -400,6 +400,17 @@ All of these errors result in an error report (using the same format
as apport) being generated, before the error-commands (if any) are as apport) being generated, before the error-commands (if any) are
run. run.
Error reports are represented over the API by the `ErrorReportRef`
type. This contains enough information to find the error report and
know if it is complete yet (there is an API method `errors.wait.GET()`
that will block until the error report has been completed).
Immediate errors end up in the `error` field in the return value for
`meta.status.GET()`.
When an API error happens, the server puts a serialized
`ErrorReportRef` in the `x-error-report` header of the response.
Some things that could be considered "errors", like failing to contact Some things that could be considered "errors", like failing to contact
the snap store are ignored and not presented to the user, instead the the snap store are ignored and not presented to the user, instead the
relevant screens are skipped. relevant screens are skipped.