diff options
| author | Milo Casagrande <milo.casagrande@linaro.org> | 2014-08-12 16:25:45 +0200 |
|---|---|---|
| committer | Milo Casagrande <milo.casagrande@linaro.org> | 2014-08-12 16:25:45 +0200 |
| commit | 443d5988a94709fe39527125bc9d9c2c060e81a0 (patch) | |
| tree | 9230772b6759e75fed537be12cf84ef361544322 /doc | |
| parent | 1f847ac0dd1a0779cb07034925525dd8ff6f66f4 (diff) | |
doc: Add initial schema definitions.
Change-Id: Ia90e80f2f220592071a3c1ca559f6b337fbc111b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.rst | 1 | ||||
| -rw-r--r-- | doc/schema-job.rst | 84 | ||||
| -rw-r--r-- | doc/schema.rst | 9 |
3 files changed, 94 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst index 720fd24..1ae2a38 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,3 +6,4 @@ API Documentation intro collections + schema diff --git a/doc/schema-job.rst b/doc/schema-job.rst new file mode 100644 index 0000000..d09944a --- /dev/null +++ b/doc/schema-job.rst @@ -0,0 +1,84 @@ +.. _schema_job: + +job +--- + +A job is composed of an actual job name and a kernel name. The ID is formed +by concatenating these two values: ``job``-``kernel``. + +At a lower level, a job is the top level directory of the results from a CI +build. + +:: + + { + "title": "job", + "description": "A job as provided by the CI loop", + "type": "object", + "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" + }, + "created_on": { + "type": "object", + "description": "Creation date of the job", + "properties": { + "$date": { + "type": "number", + "description": "Milliseconds from epoch time" + } + } + }, + "updated": { + "type": "object", + "description": "Date the job was updated", + "properties": { + "$date": { + "type": "number", + "description": "Milliseconds from epoch time" + } + } + }, + "job": { + "type": "string", + "description": "The name of the job" + }, + "metadata": { + "type": "object", + "description": "A free form object that can contain different properties", + "properties": { + "git_branch": { + "type": "string", + "description": "The kernel branch name" + }, + "git_commit": { + "type": "string", + "description": "The commit SHA" + }, + "git_url": { + "type": "string", + "description": "URL of the git repository" + }, + "git_describe": { + "type": "string", + "description": "Name of the repository" + } + } + } + } + } + +More Info +********* + +* :ref:`API results <intro_schema_results>` +* :ref:`Schema time and date <intro_schema_time_date>` diff --git a/doc/schema.rst b/doc/schema.rst new file mode 100644 index 0000000..c39d4c9 --- /dev/null +++ b/doc/schema.rst @@ -0,0 +1,9 @@ +.. _schema: + +Schema +====== + +.. toctree:: + :maxdepth: 1 + + schema-job |