Doc updates.

Change-Id: I34e81f5413e219704a6d79e06ba6cee65d9c87fa

2 files changed, 180 insertions, 13 deletions

diff --git a/doc/schema-boot.rst b/doc/schema-boot.rst
index 13785ec..606a66d 100644
--- a/doc/schema-boot.rst
+++ b/doc/schema-boot.rst
@@ -48,6 +48,10 @@ necessary to use its ``_id`` value.
                 "type": "string",
                 "description": "The job associated with this object"
             },
+            "job_id": {
+                "type": "string",
+                "description": "The ID of the associated job"
+            },
             "kernel": {
                 "type": "string",
                 "description": "The kernel associated with this object"
diff --git a/doc/schema-defconfig.rst b/doc/schema-defconfig.rst
index 727d64e..9c7f796 100644
--- a/doc/schema-defconfig.rst
+++ b/doc/schema-defconfig.rst
@@ -3,11 +3,17 @@
 defconfig
 ---------
 
-A defconfig ID is composed of a job ID and the defconfig name as follows:
-``job``-``kernel``-``name``.
+A defconfig ``name`` is composed of the job, kernel and defconfig values:
+``job``-``kernel``-``defconfig``.
 
-At a lower level a defconfig is the directory resulting from a kernel build
-using a defconfig.
+At a lower level the ``defconfig`` is the directory resulting from a kernel build using a defconfig.
+
+.. _schema_defconfig_get:
+
+GET
+***
+
+The following schema covers the data that is available with a GET request.
 
 ::
 
@@ -16,6 +22,15 @@ using a defconfig.
         "description": "A defconfig as built by the CI loop",
         "type": "object",
         "properties": {
+            "version": {
+                "type": "string",
+                "description": "The version number of this JSON schema",
+                "enum": ["1.0"]
+            },
+            "name": {
+                "type": "string",
+                "description": "The name of this object (internally created)"
+            },
             "_id": {
                 "type": "string",
                 "description": "The ID associated with the object"
@@ -34,6 +49,10 @@ using a defconfig.
                 "type": "string",
                 "description": "The job associated with this object"
             },
+            "job_id": {
+                "type": "string",
+                "description": "The ID of the associated job"
+            },
             "kernel": {
                 "type": "string",
                 "description": "The kernel associated with this object"
@@ -49,24 +68,46 @@ using a defconfig.
             "status": {
                 "type": "string",
                 "description": "The status of the defconfig",
-                "items": {
-                    "FAIL",
-                    "PASS",
-                    "UNKNOWN"
-                }
+                "enum": ["FAIL", "PASS", "UNKNOWN"]
             },
             "errors": {
-                "type": "number",
-                "description": "Number of errors reported"
+                "type": "integer",
+                "description": "Number of errors reported",
+                "default": 0
             },
             "warnings": {
-                "type": "number",
-                "description": "Number of warnings reported"
+                "type": "integer",
+                "description": "Number of warnings reported",
+                "default": 0
             },
             "arch": {
                 "type": "string",
                 "description": "The architecture of the defconfig built"
             },
+            "build_time": {
+                "type": "number",
+                "description": "The time taken to build this defconfig"
+            },
+            "git_url": {
+                "type": "string",
+                "description": "The URL of the git web interface where the code used to build can be found"
+            },
+            "git_commit": {
+                "type": "string",
+                "description": "The git SHA of the commit used for the build"
+            },
+            "git_branch": {
+                "type": "string",
+                "description": "The name of the branch"
+            },
+            "git_describe": {
+                "type": "string",
+                "description": "The name of the git describe command"
+            },
+            "build_platform": {
+                "type": "array",
+                "description": "An array with info about the build platform"
+            },
             "metadata": {
                 "type": "object",
                 "description": "A free form object that can contain different properties"
@@ -74,6 +115,128 @@ using a defconfig.
         }
     }
 
+.. _schema_defconfig_post:
+
+POST
+****
+
+The following schema covers the data that should be available in a build JSON
+data file sent to the server.
+
+The ``defconfig`` collection does not support POST requests, it is placed here
+only to be included among the ``defconfig`` schema.
+
+::
+
+    {
+        "title": "defconfig",
+        "description": "A defconfig as built by the CI loop",
+        "type": "object",
+        "properties": {
+            "version": {
+                "type": "string",
+                "description": "The version number of this JSON schema",
+                "enum": ["1.0"]
+            },
+            "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"
+            },
+            "build_status": {
+                "type": "string",
+                "description": "The status of the defconfig",
+                "enum": ["FAIL", "PASS", "UNKNOWN"]
+            },
+            "build_errors": {
+                "type": "integer",
+                "description": "Number of errors reported",
+                "default": 0
+            },
+            "build_warnings": {
+                "type": "integer",
+                "description": "Number of warnings reported",
+                "default": 0
+            },
+            "arch": {
+                "type": "string",
+                "description": "The architecture of the defconfig built"
+            },
+            "build_time": {
+                "type": "number",
+                "description": "The time taken to build this defconfig",
+                "default": 0
+            },
+            "git_url": {
+                "type": "string",
+                "description": "The URL of the git web interface where the code used to build can be found"
+            },
+            "git_commit": {
+                "type": "string",
+                "description": "The git SHA of the commit used for the build"
+            },
+            "git_branch": {
+                "type": "string",
+                "description": "The name of the branch"
+            },
+            "git_describe": {
+                "type": "string",
+                "description": "The name of the git describe command"
+            },
+            "build_log": {
+                "type": "string",
+                "description": "Name of the build log file in txt format"
+            },
+            "build_platform": {
+                "type": "array",
+                "description": "An array with info about the build platform"
+            },
+            "dtb_dir": {
+                "type": "string",
+                "description": "Name of the dtb directory"
+            },
+            "compiler_version": {
+                "type": "string",
+                "description": "Description string of the compiler used"
+            },
+            "kconfig_fragments": {
+                "type": "string",
+                "description": "The config fragment used"
+            },
+            "kernel_config": {
+                "type": "string",
+                "description": "Name of the kernel config file used"
+            },
+            "kernel_image": {
+                "type": "string",
+                "description": "Name of the kernel image created"
+            },
+            "cross_compile": {
+                "type": "string",
+                "description": "The cross compiler used"
+            },
+            "modules": {
+                "type": "string",
+                "description": "Name of the modules file"
+            },
+            "system_map": {
+                "type": "string",
+                "description": "Name of the system map file"
+            },
+            "text_offset": {
+                "type": "string"
+            }
+        }
+    }
+
+
 More Info
 *********