REST API Schemas¶

REST API request and response schemas.

Overview¶

All API endpoints use JSON Schema validated requests and responses.

{
  "data": [],
  "paging": {
    "after": "cursor",
    "total": 100
  }
}

{
  "name": "entity_name",
  "description": "Description",
  "owner": {"type": "user", "id": "uuid"}
}

[
  {
    "op": "replace",
    "path": "/description",
    "value": "New description"
  }
]

{
  "code": 400,
  "message": "Validation error",
  "details": "Field 'name' is required"
}