diff options
| author | UMTS at Teleco <crt@teleco.ch> | 2026-02-15 15:53:50 +0100 |
|---|---|---|
| committer | UMTS at Teleco <crt@teleco.ch> | 2026-02-15 15:53:50 +0100 |
| commit | fa680b24d1123f9de27fc752943e43c86c692314 (patch) | |
| tree | e4875712a0f8298819c490dc42e881218a2175bc /README.md | |
JAYSON DERULO
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..33b3998 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# JsonDerulo API Spec. v2.0 + + +## What is this? +- JsonDerulo Compliant Server Requirements + - JsonDerulo (v2) shouldn't be viewed as something only implemented by one backend (even if it is sofar only implemented by one which serves as reference called SeckelAPI) + - Intended to serve as a reference for anyone trying to build a compliant one in any programing language of their choice. +- JsonDerulo Compliant Client Requirements + - What basic features every client must support + - So intercompatible programms and stuff are possible, core features like : + - Listing toolkit compatibility + - If gui like a module chooser idk + - format standards idk + - handling of json responses with unexpected fields (dont crash but like warn in console) +- Generally serve as an API Reference of what features can do what and how to do em. + +## What this isnt? +- Guide on how to configure a specific server + - For that wait on the release of the SeckelAPI Server v2 which is kinda used as a reference server and should include configuration docs. + +## Navigation + +### Basics +- [Overview](overview.md) the fundamentals like base url, content types, rate limiting, date formats +- [Errors](errors.md) what error responses look like and what status codes mean +- [Client Requirements](client.md) what a compliant client needs to support + +### Authentication +- [Auth](auth/README.md) login, logout, session status, clearing sessions + +### Database Queries +- [Query](query/README.md) the unified /query endpoint for select, insert, update, delete, count and batching + +### Permissions +- [Permissions](permissions/README.md) table level, column level, ownership scoping + +### Schema +- [Schema](schema/README.md) core tables, system columns, session persistence + +### Administration +- [Admin](admin/README.md) config reload, user preferences, config priority + +### Toolkits +- [Toolkits](toolkits/README.md) custom endpoints, toolkit groups, the whole plugin system
\ No newline at end of file |