JsonDerulo-API-Spec

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 the fundamentals like base url, content types, rate limiting, date formats
• Errors what error responses look like and what status codes mean
• Client Requirements what a compliant client needs to support

Authentication

• Auth login, logout, session status, clearing sessions

Database Queries

• Query the unified /query endpoint for select, insert, update, delete, count and batching

Permissions

• Permissions table level, column level, ownership scoping

Schema

• Schema core tables, system columns, session persistence

Administration

• Admin config reload, user preferences, config priority

Toolkits

• Toolkits custom endpoints, toolkit groups, the whole plugin system