Commit 5b469524 authored by Siebers, Michael's avatar Siebers, Michael
Browse files

refined irrelevancy and explanation response schemas

parent ae7173fe
......@@ -341,7 +341,7 @@ Explains why an irrelevant file is irrelevant.
- `explanations`: A list of explanations (see below).
- `further_explanations`: `true` if more explanations are available
On success, the response body follows this [JSON schema](</doc/schema/response-explain-schema.json>).
On success, the response body follows this [JSON schema](</doc/schema/response-explain-schema.json>). An example for a response body can be found below and in the [example file](</doc/schema/response-explain-example.json>).
#### Explanations
......
{
"explanations": [
{
"abs_path": "dir_1/dir_b/file_old",
"reasoning": [
{
"text": ""
}
],
"reasoning_details": [
[
{
"text": "die Dateien "
},
{
"ref_id": 0,
"text": "file_old"
},
{
"text": " und "
},
{
"ref_id": 1,
"text": "file_middle"
},
{
"text": " sind im gleichen Verzeichnis."
}
],
[
{
"text": "Datei "
},
{
"ref_id": 1,
"text": "file_middle"
},
{
"text": " ist "
},
{
"ref_id": 2,
"text": "neuer"
},
{
"text": " als Datei "
},
{
"ref_id": 0,
"text": "file_old"
},
{
"text": "."
}
]
],
"references": [
{
"id": 2,
"referenced_entities": [
{
"abs_path": "dir_1/dir_b/file_middle",
"property": "mtime"
},
{
"abs_path": "dir_1/dir_b/file_old",
"property": "mtime"
}
]
},
{
"id": 1,
"referenced_entities": [
{
"abs_path": "dir_1/dir_b/file_middle",
"property": "name"
}
]
},
{
"id": 0,
"referenced_entities": [
{
"abs_path": "dir_1/dir_b/file_old",
"property": "name"
}
]
}
]
},
{
"abs_path": "dir_1/dir_b/file_old",
"reasoning": [
{
"text": ""
}
],
"reasoning_details": [
[
{
"text": "die Dateien "
},
{
"ref_id": 0,
"text": "file_old"
},
{
"text": " und "
},
{
"ref_id": 1,
"text": "file_new"
},
{
"text": " sind im gleichen Verzeichnis."
}
],
[
{
"text": "Datei "
},
{
"ref_id": 1,
"text": "file_new"
},
{
"text": " ist "
},
{
"ref_id": 2,
"text": "neuer"
},
{
"text": " als Datei "
},
{
"ref_id": 0,
"text": "file_old"
},
{
"text": "."
}
]
],
"references": [
{
"id": 2,
"referenced_entities": [
{
"abs_path": "dir_1/dir_b/file_new",
"property": "mtime"
},
{
"abs_path": "dir_1/dir_b/file_old",
"property": "mtime"
}
]
},
{
"id": 1,
"referenced_entities": [
{
"abs_path": "dir_1/dir_b/file_new",
"property": "name"
}
]
},
{
"id": 0,
"referenced_entities": [
{
"abs_path": "dir_1/dir_b/file_old",
"property": "name"
}
]
}
]
}
],
"further_explanations": false
}
......@@ -50,17 +50,21 @@
"type": "string",
"minimumLength": 1
}
}
},
"additionalProperties": false
}
}
}
},
"additionalProperties": false
}
}
}
}
},
"additionalProperties": false
}
},
"further_explanations": {"type": "boolean"}
},
"additionalProperties": false,
"definitions": {
"message_part": {
"description": "A small part of a message possibly relating to a reference.",
......
......@@ -11,5 +11,6 @@
},
"required": [
"result"
]
],
"additionalProperties": false
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment