Schema Overview
┌───────────────────────┬────────────────────────────────────────────────────────┐
│ Endpoint │ Description │
├───────────────────────┼────────────────────────────────────────────────────────┤
│ GET /api/store/schema │ Full schema overview (class/property counts and lists) │
└───────────────────────┴────────────────────────────────────────────────────────┘
Classes (13 endpoints)
┌─────────────────────────────────────────────────┬──────────────────────────────────────────────────────────────────────┐
│ Endpoint │ Description │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes │ List all classes with count │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class │ Full class description (slots, hierarchy, instance count, abstract?) │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/instances │ All instances (including subclass instances) │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/instances/direct │ Direct instances only │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/slots │ All effective slots with domain/range/cardinality details │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/slots/direct │ Direct slots only (not inherited) │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/slots/required │ Required slots only │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/hierarchy │ Full hierarchy (parents, ancestors, subclasses) │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/subclasses │ All transitive subclasses │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/subclasses/direct │ Direct subclasses only │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/ancestors │ All ancestor classes │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/parents │ Direct parent classes │
├─────────────────────────────────────────────────┼──────────────────────────────────────────────────────────────────────┤
│ GET /api/store/classes/:class/validate │ Validate all instances of class (including subclass instances) │
└─────────────────────────────────────────────────┴──────────────────────────────────────────────────────────────────────┘
Properties (4 endpoints)
┌────────────────────────────────────────┬───────────────────────────────────────────────────────────────────┐
│ Endpoint │ Description │
├────────────────────────────────────────┼───────────────────────────────────────────────────────────────────┤
│ GET /api/store/properties │ List all properties │
├────────────────────────────────────────┼───────────────────────────────────────────────────────────────────┤
│ GET /api/store/properties/:prop │ Full property description (domain, range, cardinality, required?) │
├────────────────────────────────────────┼───────────────────────────────────────────────────────────────────┤
│ GET /api/store/properties/:prop/domain │ Property's domain class with description │
├────────────────────────────────────────┼───────────────────────────────────────────────────────────────────┤
│ GET /api/store/properties/:prop/range │ Property's range type with description │
└────────────────────────────────────────┴───────────────────────────────────────────────────────────────────┘
Entities (3 endpoints)
┌──────────────────────────────────────┬─────────────────────────────────────┐
│ Endpoint │ Description │
├──────────────────────────────────────┼─────────────────────────────────────┤
│ GET /api/store/entities/:id │ Get entity by db/id or db/ident │
├──────────────────────────────────────┼─────────────────────────────────────┤
│ GET /api/store/entities/:id/validate │ Validate entity against its class │
├──────────────────────────────────────┼─────────────────────────────────────┤
│ GET /api/store/entities/:id/class │ Get entity's class with description │
└──────────────────────────────────────┴─────────────────────────────────────┘
Type Predicates (2 endpoints)
┌─────────────────────────────────────────────────┬──────────────────────────────────────┐
│ Endpoint │ Description │
├─────────────────────────────────────────────────┼──────────────────────────────────────┤
│ GET /api/store/types/instance-of/:class/:id │ Check if entity is instance of class │
├─────────────────────────────────────────────────┼──────────────────────────────────────┤
│ GET /api/store/types/subclass-of/:parent/:child │ Check if child is subclass of parent │
└─────────────────────────────────────────────────┴──────────────────────────────────────┘
Can you improve this documentation?Edit on GitHub
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |