diff options
author | Milo Casagrande <milo.casagrande@linaro.org> | 2014-12-19 15:33:19 +0100 |
---|---|---|
committer | Milo Casagrande <milo.casagrande@linaro.org> | 2014-12-19 15:33:19 +0100 |
commit | 06b869ec52a081909b9c5ee42c167de86a6f8cda (patch) | |
tree | e12a1a9a45b3e333182ff14af62f4ec0dc41fdbf /doc | |
parent | b2ef352d536c971007c1148f7be3e48d940bdaef (diff) |
doc: Add mach filed descriptions.
Change-Id: Iafd206f1fa52238f19fbb2a114b57ef623ab9689
Diffstat (limited to 'doc')
-rw-r--r-- | doc/collection-boot.rst | 17 | ||||
-rw-r--r-- | doc/schema-boot.rst | 8 |
2 files changed, 17 insertions, 8 deletions
diff --git a/doc/collection-boot.rst b/doc/collection-boot.rst index 8ae4f30..1c6a8e1 100644 --- a/doc/collection-boot.rst +++ b/doc/collection-boot.rst @@ -40,6 +40,7 @@ GET :query string job_id: The ID of a job. :query string kernel: The name of a kernel. :query string lab_name: The name of the lab that created the boot report. + :query string mach: The machine type. :query string name: The name of the boot report. :query string status: The status of the boot report. :query int retries: The number of boot retries performed. @@ -140,11 +141,11 @@ POST For more info on all the required JSON request fields, see the :ref:`boot schema for POST requests <schema_boot_post>`. - :reqjson string lab_name: The name of the boot tests lab. + :reqjson string board: The name of the board. + :reqjson string defconfig: The name of the defconfig. :reqjson string job: The name of the job. :reqjson string kernel: The name of the kernel. - :reqjson string defconfig: The name of the defconfig. - :reqjson string board: The name of the board. + :reqjson string lab_name: The name of the boot tests lab. :reqjson string version: The version number of the schema. :reqheader Authorization: The token necessary to authorize the request. @@ -193,13 +194,13 @@ DELETE :resheader Content-Type: Will be ``application/json; charset=UTF-8``. :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 board: The name of a board. :query string defconfig: The name of a defconfig. :query string defconfig_full: The full name of a defconfig (with config fragments). - :query string board: The name of a board. + :query string defconfig_id: The ID of a defconfig. + :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 name: The name of a boot report. :status 200: Resource deleted. diff --git a/doc/schema-boot.rst b/doc/schema-boot.rst index dc64740..73e1221 100644 --- a/doc/schema-boot.rst +++ b/doc/schema-boot.rst @@ -188,6 +188,10 @@ necessary to use its ``_id`` value. "type": "string", "description": "The server path where the boot related files are stored" }, + "mach": { + "type": "string", + "description": "The machine (SoC) family" + }, "metadata": { "type": "object", "description": "A free form object that can contain different properties" @@ -358,6 +362,10 @@ have when sent to the server. "type": "string", "description": "The server path where the boot related files are stored" }, + "mach": { + "type": "string", + "description": "The machine (SoC) family" + }, "metadata": { "type": "object", "description": "A free form object that can contain different properties" |