index.md 1.76 KB
Newer Older
1
# JSON Schemas
Siebers, Michael's avatar
Siebers, Michael committed
2
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.
3
4
5
6
7
8
9

## Types
    | Type | Schema | Example |
    | --- | --- | --- |
    | =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>) | --- |
Siebers, Michael's avatar
Siebers, Michael committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
    | =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>) |