diff options
| author | Milo Casagrande <milo.casagrande@linaro.org> | 2014-11-13 14:38:55 +0100 |
|---|---|---|
| committer | Milo Casagrande <milo.casagrande@linaro.org> | 2014-11-13 14:38:55 +0100 |
| commit | 4fc8b081e605a6f3b2e1f55b35fb3c05bcf20c46 (patch) | |
| tree | e95abd5788c8f13587a4168f11d73c9c25ddf852 /doc/collection-defconfig.rst | |
| parent | 24ed9a6cc1cb0545df5cf8406001283490050712 (diff) | |
Doc updates.
Change-Id: I2450c714764ec854375fd302f145e11a770816e1
Diffstat (limited to 'doc/collection-defconfig.rst')
| -rw-r--r-- | doc/collection-defconfig.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/collection-defconfig.rst b/doc/collection-defconfig.rst index 6f67b6d..7c627c2 100644 --- a/doc/collection-defconfig.rst +++ b/doc/collection-defconfig.rst @@ -10,7 +10,7 @@ GET Get all the available defconfigs built or a single one if ``defconfig_id`` is provided. - :param defconfig_id: The ID of the defconfig to retrieve. Usually in the form of: ``job``-``kernel``-``defconfig``. + :param defconfig_id: The ID of the defconfig to retrieve. :type defconfig_id: string :reqheader Authorization: The token necessary to authorize the request. @@ -29,15 +29,18 @@ GET :query string field: The field that should be returned in the response. Can be 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 defconfig report. :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 name: The name of the defconfig report. :query string arch: The architecture on which the defconfig has been built. - :query string status: The status of the defconfig report. Can be one of: - ``PASS`` or ``FAIL``. + :query string status: The status of the defconfig report. :query int warnings: The number of warnings in the defconfig built. :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. :status 200: Resuslts found. :status 403: Not authorized to perform the operation. |