doc: Work on JSON schema definition.

  * Add boot and defconfig schema.
  * Fix job schema.

Change-Id: Ifc36d8410ce02a5334cfae1c879e4fa47fdbbe3d

4 files changed, 223 insertions, 10 deletions

diff --git a/doc/schema-boot.rst b/doc/schema-boot.rst
new file mode 100644
index 0000000..aaeb913
--- /dev/null
+++ b/doc/schema-boot.rst
@@ -0,0 +1,120 @@
+.. _schema_boot:
+
+boot
+----
+
+A boot ID is composed from the name of the board, the job, kernel and
+defconfig: ``board``-``job``-``kernel``-``defconfig``.
+
+The value of ``defconfig``, in this case, is the directory name containing the
+defconfig.
+
+::
+
+    {
+        "title": "boot",
+        "description": "A boot report object",
+        "type": "object",
+        "properties": {
+            "_id": {
+                "type": "string",
+                "description": "The ID associated with the object"
+            },
+            "created_on": {
+                "type": "object",
+                "description": "Creation date of the object",
+                "properties": {
+                    "$date": {
+                        "type": "number",
+                        "description": "Milliseconds from epoch time"
+                    }
+                }
+            },
+            "board": {
+                "type": "string",
+                "description": "The name of the board"
+            },
+            "job": {
+                "type": "string",
+                "description": "The job associated with this object"
+            },
+            "kernel": {
+                "type": "string",
+                "description": "The kernel associated with this object"
+            },
+            "defconfig": {
+                "type": "string",
+                "description": "The name of the defconfig as reported by the CI loop"
+            },
+            "time": {
+                "type": "object",
+                "description": "Time take to boot the board as milliseconds from epoch",
+                "properties": {
+                    "$date": {
+                        "type": "number",
+                        "description": "Milliseconds from epoch time"
+                    }
+                }
+            },
+            "status": {
+                "type": "string",
+                "description": "The status of the boot report",
+                "items": {
+                    "FAIL",
+                    "PASS",
+                    "OFFLINE"
+                }
+            },
+            "warnings": {
+                "type": "number",
+                "description": "Numbere of warnings in the boot phase"
+            },
+            "boot_log": {
+                "type": "string",
+                "description": "Name of the boot log text file"
+            },
+            "boot_log_html": {
+                "type": "string",
+                "description": "Name of the boot log HTML file"
+            },
+            "initrd_addr": {
+                "type": "string",
+                "description": "Initrd address used"
+            },
+            "load_addr": {
+                "type": "string",
+                "description": "Load address used"
+            },
+            "kernel_image": {
+                "type": "string",
+                "description": "The kernel image used to boot"
+            },
+            "dtb_addr": {
+                "type": "string",
+                "description": "The DTB address used"
+            },
+            "dtb": {
+                "type": "string",
+                "description": "The DTB file or directory used"
+            },
+            "endianness": {
+                "type": "string",
+                "description": "Endianness of the board"
+            },
+            "fastboot": {
+                "type": "boolean",
+                "description": "If it was a fastboot"
+            },
+            "metadata": {
+                "type": "object",
+                "description": "A free form object that can contain different properties"
+            }
+        }
+    }
+
+More Info
+*********
+
+* :ref:`Defconfig schema <schema_defconfig>`
+* :ref:`API results <intro_schema_results>`
+* :ref:`Schema time and date <intro_schema_time_date>`
diff --git a/doc/schema-defconfig.rst b/doc/schema-defconfig.rst
new file mode 100644
index 0000000..4e7daa4
--- /dev/null
+++ b/doc/schema-defconfig.rst
@@ -0,0 +1,81 @@
+.. _schema_defconfig:
+
+defconfig
+---------
+
+A defconfig ID is composed of a job ID and the defconfig name as follows:
+``job``-``kernel``-``name``.
+
+At a lower level a defconfig is the directory resulting from a kernel build
+using a defconfig.
+
+::
+
+    {
+        "title": "defconfig",
+        "description": "A defconfig as built by the CI loop",
+        "type": "object",
+        "properties": {
+            "_id": {
+                "type": "string",
+                "description": "The ID associated with the object"
+            },
+            "created_on": {
+                "type": "object",
+                "description": "Creation date of the object",
+                "properties": {
+                    "$date": {
+                        "type": "number",
+                        "description": "Milliseconds from epoch time"
+                    }
+                }
+            },
+            "job": {
+                "type": "string",
+                "description": "The job associated with this object"
+            },
+            "kernel": {
+                "type": "string",
+                "description": "The kernel associated with this object"
+            },
+            "defconfig": {
+                "type": "string",
+                "description": "The name of the defconfig as reported by the CI loop"
+            },
+            "dirname": {
+                "type": "string",
+                "description": "The name of the directory of the defconfig built; it can be different from the actual defconfig name"
+            },
+            "status": {
+                "type": "string",
+                "description": "The status of the defconfig",
+                "items": {
+                    "FAIL",
+                    "PASS",
+                    "UNKNOWN"
+                }
+            },
+            "errors": {
+                "type": "number",
+                "description": "Number of errors reported"
+            },
+            "warnings": {
+                "type": "number",
+                "description": "Number of warnings reported"
+            },
+            "arch": {
+                "type": "string",
+                "description": "The architecture of the defconfig built"
+            },
+            "metadata": {
+                "type": "object",
+                "description": "A free form object that can contain different properties"
+            }
+        }
+    }
+
+More Info
+*********
+
+* :ref:`API results <intro_schema_results>`
+* :ref:`Schema time and date <intro_schema_time_date>`
diff --git a/doc/schema-job.rst b/doc/schema-job.rst
index d09944a..96e16a1 100644
--- a/doc/schema-job.rst
+++ b/doc/schema-job.rst
@@ -18,19 +18,11 @@ build.
         "properties": {
             "_id": {
                 "type": "string",
-                "description": "The ID associated with this job"
-            },
-            "private": {
-                "type": "boolean",
-                "description": "If the job is private or not, default false"
-            },
-            "kernel": {
-                "type": "string",
-                "description": "The name of the kernel"
+                "description": "The ID associated with this object"
             },
             "created_on": {
                 "type": "object",
-                "description": "Creation date of the job",
+                "description": "Creation date of the object",
                 "properties": {
                     "$date": {
                         "type": "number",
@@ -38,6 +30,14 @@ build.
                     }
                 }
             },
+            "private": {
+                "type": "boolean",
+                "description": "If the job is private or not, default false"
+            },
+            "kernel": {
+                "type": "string",
+                "description": "The name of the kernel"
+            },
             "updated": {
                 "type": "object",
                 "description": "Date the job was updated",
@@ -52,6 +52,16 @@ build.
                 "type": "string",
                 "description": "The name of the job"
             },
+            "status": {
+                "type": "string",
+                "description": "The status of the job",
+                "items": {
+                    "BUILD",
+                    "FAIL",
+                    "PASS",
+                    "UNKNOWN"
+                }
+            },
             "metadata": {
                 "type": "object",
                 "description": "A free form object that can contain different properties",
diff --git a/doc/schema.rst b/doc/schema.rst
index c39d4c9..dcc16f4 100644
--- a/doc/schema.rst
+++ b/doc/schema.rst
@@ -7,3 +7,5 @@ Schema
     :maxdepth: 1
 
     schema-job
+    schema-defconfig
+    schema-boot