doc: Update boot and defconfig schemas.

Change-Id: Id0f198c437dac28291a8ab8ecb5e9ee6b1050383

4 files changed, 84 insertions, 12 deletions

diff --git a/doc/collection-boot.rst b/doc/collection-boot.rst
index ba460e6..3243f47 100644
--- a/doc/collection-boot.rst
+++ b/doc/collection-boot.rst
@@ -30,11 +30,13 @@ GET
     repeated multiple times.
  :query string nfield: The field that should *not* be returned in the response. Can be repeated multiple times.
  :query string _id: The internal ID of the boot report.
+ :query string board: The name of a board.
  :query string job: The name of a job.
  :query string job_id: The ID of a job.
  :query string kernel: The name of a kernel.
  :query string defconfig: The name of a defconfig.
- :query string endianness: The endianness of the board.
+ :query string defconfig_id: The ID of a defconfig.
+ :query string endian: The endianness of the board.
  :query string board: The name of a board.
  :query string lab_name: The name of the lab that created the boot report.
  :query string name: The name of the boot report.
@@ -140,7 +142,8 @@ POST
  :reqjson string job: The name of the job.
  :reqjson string kernel: The name of the kernel.
  :reqjson string defconfig: The name of the defconfig.
- :erqjson string board: The name of the board.
+ :reqjson string board: The name of the board.
+ :reqjson string version: The version number of the schema.
 
  :reqheader Authorization: The token necessary to authorize the request.
  :reqheader Content-Type: Content type of the transmitted data, must be ``application/json``.
@@ -187,13 +190,14 @@ DELETE
 
  :resheader Content-Type: Will be ``application/json; charset=UTF-8``.
 
- :query string job: The name of a job.
+ :query string _id: The ID of a boot report.
  :query string job_id: The ID of a job.
+ :query string job: The name of a job.
  :query string kernel: The name of a kernel.
+ :query string defconfig_id: The ID of a defconfig.
  :query string defconfig: The name of a defconfig.
  :query string board: The name of a board.
  :query string name: The name of a boot report.
- :query string _id: The ID of a boot report.
 
  :status 200: Resource deleted.
  :status 403: Not authorized to perform the operation.
diff --git a/doc/collection-defconfig.rst b/doc/collection-defconfig.rst
index 7c627c2..737ec51 100644
--- a/doc/collection-defconfig.rst
+++ b/doc/collection-defconfig.rst
@@ -41,6 +41,7 @@ GET
  :query int errors: The number of errors in the defconfig built.
  :query string git_branch: The name of the git branch.
  :query string git_commit: The git commit SHA.
+ :query string git_describe: The git describe value.
 
  :status 200: Resuslts found.
  :status 403: Not authorized to perform the operation.
diff --git a/doc/schema-boot.rst b/doc/schema-boot.rst
index 3cdaf21..bd6f4c4 100644
--- a/doc/schema-boot.rst
+++ b/doc/schema-boot.rst
@@ -49,8 +49,14 @@ necessary to use its ``_id`` value.
                 "description": "The job associated with this object"
             },
             "job_id": {
-                "type": "string",
-                "description": "The ID of the associated job"
+                "type": "object",
+                "description": "The ID of the associated job",
+                "properties": {
+                    "$oid": {
+                        "type": "string",
+                        "description": "The actual ID value"
+                    }
+                }
             },
             "kernel": {
                 "type": "string",
@@ -60,6 +66,24 @@ necessary to use its ``_id`` value.
                 "type": "string",
                 "description": "The name of the defconfig as reported by the CI loop"
             },
+            "defconfig_id": {
+                "type": "object",
+                "description": "The ID of the associated build report",
+                "properties": {
+                    "$oid": {
+                        "type": "string",
+                        "description": "The actual ID value"
+                    }
+                }
+            },
+            "git_branch": {
+                "type": "string",
+                "description": "The branch used for boot testing"
+            },
+            "git_commit": {
+                "type": "string",
+                "description": "The git SHA of the commit used for boot testing"
+            },
             "lab_name": {
                 "type": "string",
                 "description": "The name of the lab that is doing the boot tests"
diff --git a/doc/schema-defconfig.rst b/doc/schema-defconfig.rst
index 9c7f796..0a9f069 100644
--- a/doc/schema-defconfig.rst
+++ b/doc/schema-defconfig.rst
@@ -50,8 +50,14 @@ The following schema covers the data that is available with a GET request.
                 "description": "The job associated with this object"
             },
             "job_id": {
-                "type": "string",
-                "description": "The ID of the associated job"
+                "type": "object",
+                "description": "The ID of the associated job",
+                "properties": {
+                    "$oid": {
+                        "type": "string",
+                        "description": "The actual ID value"
+                    }
+                }
             },
             "kernel": {
                 "type": "string",
@@ -108,6 +114,37 @@ The following schema covers the data that is available with a GET request.
                 "type": "array",
                 "description": "An array with info about the build platform"
             },
+            "modules": {
+                "type": "string",
+                "description": "Name of the modules file"
+            },
+            "modules_dir" {
+                "type": "string",
+                "description": "Name of the modules directory"
+            },
+            "dtb_dir": {
+                "type": "string",
+                "description": "Name of the dtb directory"
+            },
+            "build_log": {
+                "type": "string",
+                "description": "Name of the build log file in txt format"
+            },
+            "text_offset": {
+                "type": "string"
+            },
+            "system_map": {
+                "type": "string",
+                "description": "Name of the system map file"
+            },
+            "kernel_config": {
+                "type": "string",
+                "description": "Name of the kernel config file used"
+            },
+            "kernel_image": {
+                "type": "string",
+                "description": "Name of the kernel image created"
+            },
             "metadata": {
                 "type": "object",
                 "description": "A free form object that can contain different properties"
@@ -123,8 +160,9 @@ 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.
+The ``defconfig`` collection does not support POST requests. This schema is
+placed here as a reference document in order to provide correct data to the
+server.
 
 ::
 
@@ -150,7 +188,7 @@ only to be included among the ``defconfig`` schema.
                 "type": "string",
                 "description": "The name of the defconfig as reported by the CI loop"
             },
-            "build_status": {
+            "build_result": {
                 "type": "string",
                 "description": "The status of the defconfig",
                 "enum": ["FAIL", "PASS", "UNKNOWN"]
@@ -226,6 +264,10 @@ only to be included among the ``defconfig`` schema.
                 "type": "string",
                 "description": "Name of the modules file"
             },
+            "modules_dir" {
+                "type": "string",
+                "description": "Name of the modules directory"
+            },
             "system_map": {
                 "type": "string",
                 "description": "Name of the system map file"
@@ -233,7 +275,8 @@ only to be included among the ``defconfig`` schema.
             "text_offset": {
                 "type": "string"
             }
-        }
+        },
+        "required": ["version", "job", "kernel", "defconfig"]
     }