Commit e7775938 authored by Siebers, Michael's avatar Siebers, Michael
Browse files

document explanation type

parent 74589312
......@@ -343,12 +343,16 @@ Explains why an irrelevant file is irrelevant.
- `code`: the HTTP status code (400)
- `message`: an error message
In case of an error, the response body follows [this JSON schema](</doc/schema/response-error-schema.json>).
On success, the response body follows this [JSON schema](</doc/schema/response-explain-schema.json>). Otherwise, the response body follows the [error schema](</doc/schema/response-error-schema.json>).
#### Explanation type
TODO
#### Explanations
An explanation consists of four parts:
- the path of the irrelevant file explained (`abs_path`, Path),
- a top-level view reasoning why the file is irrelevant (`reasoning`),
- a detailed step-by-step reasoning why the file is irrelevant (`reasoning_details`), and
- references to the 'real-world' file system (`references`).
#### Example Call
......
Supports Markdown
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