aboutsummaryrefslogtreecommitdiff
path: root/doc/schema-report.rst
blob: 14b2e676d04a5c9bd456f61d7c56ddb52328fb63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.. _schema_report:

report
------

GET
***

::

    {
        "title": "report",
        "description": "A report object",
        "type": "object",
        "properties": {
            "version": {
                "type": "string",
                "description": "The version of this JSON schema",
                "enum": ["1.0"]
            },
            "name": {
                "type": "string",
                "description": "The name associated with the object"
            },
            "_id": {
                "type": "string",
                "description": "The ID associated with the object as provided by the database"
            },
            "created_on": {
                "type": "object",
                "description": "Creation date of the object",
                "properties": {
                    "$date": {
                        "type": "number",
                        "description": "Milliseconds from epoch time",
                        "format": "utc-millisec"
                    }
                }
            },
            "updated_on": {
                "type": "object",
                "description": "Update date of the object",
                "properties": {
                    "$date": {
                        "type": "number",
                        "description": "Milliseconds from epoch time",
                        "format": "utc-millisec"
                    }
                }
            },
            "errors": {
                "type": "array",
                "description": "An array of arrays containing error codes and descriptions from the SMTP server"
            },
            "job": {
                "type": "string",
                "description": "The job name associated with the object"
            },
            "kernel": {
                "type": "string",
                "decsription": "The kernel name associated with the object"
            },
            "type": {
                "type": "string",
                "description": "The type of the report",
                "enum": ["boot", "build"]
            },
            "status": {
                "type": "string",
                "description": "The status of the report",
                "enum": ["SENT", "ERROR"]
            }
        }
    }

More Info
*********

* :ref:`API results <intro_schema_results>`
* :ref:`Schema time and date <intro_schema_time_date>`