Commit 888b7410 authored by Siebers, Michael's avatar Siebers, Michael
Browse files

written schema overview

parent fe57a901
......@@ -31,7 +31,7 @@ The Reasoning WebAPI server provides its own documentation. It is split in three
### User documentation
1. [User Guide](<user_guide.html>) (incomplete)
1. [API endpoints](<api_endpoints.html>)
1. [JSON Schemas](<schemas.html>)
1. [JSON Schemas](<schema/index.html>)
### Admin documentation
1. [Admin Guide](<admin_guide.html>) (incomplete)
......
# JSON Schemas
API POST requests and responses contain payload formatted as JSON. For each respective request and response, the schemas are linked in the [API endpoint documentation](</doc/api_endpoints.html>). This page provides an overview of the schemas.
Most API endpoint require a JSON document as requests body and respond with a JSON document. For each respective request and response, the schemas are linked in the [API endpoint documentation](</doc/api_endpoints.html>). This page provides an overview.
## Types
| Type | Schema | Example |
......@@ -7,4 +7,17 @@ API POST requests and responses contain payload formatted as JSON. For each resp
| =Directory= | [Schema](<type-directory-schema.json>) | [Example](<type-directory-example.json>) |
| =File= | [Schema](<type-file-schema.json>) | [Example](<type-file-example.json>) |
| =Item= | [Schema](<type-item-schema.json>) | --- |
| =|Manipulation Response|= | [Schema](<type-manipulation-response-schema.json>) | [Example](<type-manipulation-response-example.json>) |
| =Path= | [Schema](<type-path-schema.json>) | --- |
## Responses
| Endpoint | Request | Response |
| --- | --- | --- |
| =|/bg/add|= | Schema | [Schema](</doc/schema/response-bg-add-schema.json>), [Example](</doc/schema/response-bg-add-example.json>) |
| =|/bg/clear|= | Schema | [Schema](</doc/schema/response-bg-clear-schema.json>), [Example](</doc/schema/response-bg-clear-example.json>) |
| =|/bg/remove|= | Schema | [Schema](</doc/schema/response-bg-remove-schema.json>), [Example](</doc/schema/response-bg-remove-example.json>) |
| =|/bg/show|= | Schema | [Schema](</doc/schema/response-bg-show-schema.json>), [Example](</doc/schema/response-bg-show-example.json>) |
| =|/explain|= | Schema | [Schema](</doc/schema/response-explain-schema.json>), [Example](</doc/schema/response-explain-example.json>) |
| =|/irrelevant/file|= | Schema | [Schema](</doc/schema/response-irrelevant-file-schema.json>) |
| =|/state|= | Schema | [Schema](</doc/schema/response-state-schema.json>), [Example](</doc/schema/response-state-example.json>) |
| =|Error Response|= (for all endpoints) | --- | [Schema](</doc/schema/response-error-schema.json>), [Example](</doc/schema/response-error-example.json>) |
{
"remove_all": true,
"removed": 763,
"skipped": 0
}
{
"item_count": 17,
"list": [
{
"abs_path": "dir_1",
"creation_time": 1604235209,
"type": "directory"
},
{
"abs_path": "dir_1/file_old",
"access_time": 1604711922,
"change_time": 1604711922,
"creation_time": 1604571092,
"file_size": 17369,
"filename_extension": "",
"media_type": "text",
"modification_time": 1604710192,
"type": "file"
},
{
"abs_path": "dir_1/file_new",
"access_time": 1604719380,
"change_time": 1604711938,
"creation_time": 1604252069,
"file_size": 2342754,
"filename_extension": "csv",
"media_type": "other",
"modification_time": 1604710193,
"type": "file"
},
{
"abs_path": "dir_2",
"creation_time": 624782347,
"type": "directory"
},
{
"abs_path": "dir_2/file_old",
"access_time": 628345783,
"change_time": 624834578,
"creation_time": 624823457,
"file_size": 17369,
"filename_extension": "",
"media_type": "text",
"modification_time": 624834578,
"type": "file"
},
{
"abs_path": "dir_2/file_new",
"access_time": 724847806,
"change_time": 724847806,
"creation_time": 624783475,
"file_size": 2342754,
"filename_extension": "csv",
"media_type": "other",
"modification_time": 724834780,
"type": "file"
},
{
"abs_path": "dir_1/dir_a",
"creation_time": 1604235709,
"type": "directory"
},
{
"abs_path": "dir_1/dir_a/file_new",
"access_time": 1605870913,
"change_time": 1605870913,
"creation_time": 1604357091,
"file_size": 12038,
"filename_extension": "txt",
"media_type": "text",
"modification_time": 1604587091,
"type": "file"
},
{
"abs_path": "dir_1/dir_a/file_old",
"access_time": 1604379922,
"change_time": 1604379192,
"creation_time": 1604370912,
"file_size": 12479123,
"filename_extension": "pdf",
"media_type": "pdf",
"modification_time": 1604379192,
"type": "file"
},
{
"abs_path": "dir_1/dir_b",
"creation_time": 1604257037,
"type": "directory"
},
{
"abs_path": "dir_1/dir_b/file_old",
"access_time": 1614372311,
"change_time": 1614357237,
"creation_time": 1614257037,
"file_size": 2334634,
"filename_extension": "jpg",
"media_type": "image",
"modification_time": 1614357237,
"type": "file"
},
{
"abs_path": "dir_1/dir_b/file_middle",
"access_time": 1614729192,
"change_time": 1614727992,
"creation_time": 1604270317,
"file_size": 7823156,
"filename_extension": "png",
"media_type": "image",
"modification_time": 1614372799,
"type": "file"
},
{
"abs_path": "dir_1/dir_b/file_new",
"access_time": 1614378004,
"change_time": 1614378004,
"creation_time": 1604570361,
"file_size": 897234,
"filename_extension": "jpg",
"media_type": "image",
"modification_time": 1614372800,
"type": "file"
},
{
"abs_path": "dir_2/dir_a/dir_i",
"creation_time": 734623467,
"type": "directory"
},
{
"abs_path": "dir_2/dir_a/dir_i/file_old",
"access_time": 934467403,
"change_time": 734646740,
"creation_time": 734634670,
"file_size": 72346,
"filename_extension": "csv",
"media_type": "other",
"modification_time": 734646740,
"type": "file"
},
{
"abs_path": "dir_2/dir_a/dir_i/file_middle",
"access_time": 746474048,
"change_time": 746474048,
"creation_time": 746234617,
"file_size": 234842,
"filename_extension": "pdf",
"media_type": "pdf",
"modification_time": 746474048,
"type": "file"
},
{
"abs_path": "dir_2/dir_a/dir_i/file_new",
"access_time": 746475489,
"change_time": 746475489,
"creation_time": 734623472,
"file_size": 145678,
"filename_extension": "jpg",
"media_type": "image",
"modification_time": 746474489,
"type": "file"
}
]
}
{
"status": "running",
"version": "1.0.0"
}
# JSON Schemas
- basic information on schemas
- defined schemas with links
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