diff options
| author | Milo Casagrande <milo.casagrande@linaro.org> | 2015-01-09 14:53:20 +0100 |
|---|---|---|
| committer | Milo Casagrande <milo.casagrande@linaro.org> | 2015-01-09 14:53:20 +0100 |
| commit | 1cfc6fccc3c92b4e97d138d023e7214c7ce64a49 (patch) | |
| tree | 3d4123b04c3fe73eb871e2bb8753eb9757215796 /doc | |
| parent | c9746991ef53e83658958d8e2c5e52510bf627cb (diff) | |
doc: Add report schema definition.
Change-Id: I1aeb6cd68c2c89ba8fa4fa4ed40aa6adc62d4f31
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/schema-report.rst | 80 | ||||
| -rw-r--r-- | doc/schema.rst | 1 |
2 files changed, 81 insertions, 0 deletions
diff --git a/doc/schema-report.rst b/doc/schema-report.rst new file mode 100644 index 0000000..14b2e67 --- /dev/null +++ b/doc/schema-report.rst @@ -0,0 +1,80 @@ +.. _schema_report: + +report +------ + +GET +*** + +:: + + { + "title": "report", + "description": "A report object", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "The version of this JSON schema", + "enum": ["1.0"] + }, + "name": { + "type": "string", + "description": "The name associated with the object" + }, + "_id": { + "type": "string", + "description": "The ID associated with the object as provided by the database" + }, + "created_on": { + "type": "object", + "description": "Creation date of the object", + "properties": { + "$date": { + "type": "number", + "description": "Milliseconds from epoch time", + "format": "utc-millisec" + } + } + }, + "updated_on": { + "type": "object", + "description": "Update date of the object", + "properties": { + "$date": { + "type": "number", + "description": "Milliseconds from epoch time", + "format": "utc-millisec" + } + } + }, + "errors": { + "type": "array", + "description": "An array of arrays containing error codes and descriptions from the SMTP server" + }, + "job": { + "type": "string", + "description": "The job name associated with the object" + }, + "kernel": { + "type": "string", + "decsription": "The kernel name associated with the object" + }, + "type": { + "type": "string", + "description": "The type of the report", + "enum": ["boot", "build"] + }, + "status": { + "type": "string", + "description": "The status of the report", + "enum": ["SENT", "ERROR"] + } + } + } + +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 index e778af7..5203dc8 100644 --- a/doc/schema.rst +++ b/doc/schema.rst @@ -12,3 +12,4 @@ Schema schema-token schema-batch schema-lab + schema-report |