Commit 1c9d9563 authored by Sebastian Seufert's avatar Sebastian Seufert
Browse files

moving

parent 7b72f956
**Set Background Knowledge**
----
Set or modify background knowledge
* **URL**
/bg
* **Method:**
`POST`
* **URL Params**
**Required:**
None
* **Data Params**
**Required:**
A single item or a list of items as defined in [schema/filesystem-data-schema.json](schema/filesystem-data-schema.json).
* **Success Response:**
* **Code:** 201 <br />
**Content:** Created Message + Count
OR
* **Code:** 204 <br />
**Content:** Skipping since already present
* **Error Response:**
_tbd_
* **Sample Call:**
```shell
curl -X POST -H "Content-Type: application/json" -d '{...}' http://localhost:4444/bg
```
**Clear Background Knowledge**
----
Delete some or all of the background knowledge
* **URL**
/clear
* **Method:**
`POST`
* **URL Params**
**Required:**
None
* **Data Params**
**Required:**
A single item or a list of items as defined in [schema/filesystem-data-schema.json](schema/filesystem-data-schema.json).
* **Success Response:**
* **Code:** 205 <br />
**Content:** Cleared Content Message + Count
OR
* **Code:** 204 <br />
**Content:** Skipping since not existing
* **Error Response:**
_tbd_
* **Sample Call:**
``` curl -X POST -H "Content-Type: application/json" -d '{...}' http://localhost:4444/clear ```
**Get Irrelevant Files**
----
A list of irrelevant files in a directory
* **URL**
/irrelevant/file
* **Method:**
`POST`
* **URL Params**
**Required:**
None
* **Data Params**
**Required:**
A single file identified by its `abs_path`, having the format `{ "abs_path" : "<PATH>" }`.
* **Success Response:**
* **Code:** 200 <br />
**Content:** A list of files in relation
OR
* **Code:** 202 <br />
**Content:** Accepted & searching (if threaded)
OR
* **Code:** 204 <br />
**Content:** Nothing found
* **Error Response:**
_tbd_
* **Sample Call:**
``` curl -X POST -H "Content-Type: application/json" -d '{...}' http://localhost:4444/irrelevant/file ```
**Get Irrelevant Folders**
----
A list of irrelevant folders
_tbd_ / _to_ _do_
**Get Explanation**
----
A list of explanations of irrelevance
* **URL**
/explain
* **Method:**
`POST`
* **URL Params**
**Required:**
None
* **Data Params**
**Required:**
A single file as defined in [schema/filesystem-data-schema.json](schema/filesystem-data-schema.json). with a limit as int (__tbd__)
* **Success Response:**
* **Code:** 200 <br />
**Content:** A list of explanations as defined in [schema/expl-response-schema.json](schema/expl-response-schema.json). with a flag `{ "list-exhaustive" : true|false }` indicating if answers are exhaustive
OR
* **Code:** 202 <br />
**Content:** Accepted & searching (if threaded)
OR
* **Code:** 204 <br />
**Content:** Nothing found
* **Error Response:**
_tbd_
* **Sample Call:**
``` curl -X POST -H "Content-Type: application/json" -d '{...}' http://localhost:4444/explain ```
\ No newline at end of file
###
- [Starting the server](startup-running.md)
- [Requests](requests.md)
- [Schema](schema.md)
---
- Version 0.1
\ No newline at end of file
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