﻿# JSON Schemas

Complete reference for all JSON schemas used in Cyoda

# JSON Schemas

This section documents the JSON schemas used by the Cyoda platform — CloudEvent
payloads exchanged over the gRPC processing stream, plus the entity and model
structures that travel over REST and gRPC.

The schemas shown here were captured against **cyoda-go v0.6.2**.
For the version you are running, `cyoda help cloudevents` (narrative) and
`cyoda help cloudevents json` (machine-readable) on your own binary are
authoritative — the binary ships its own schema tree and always matches its
own code.

## Download Schemas

You can download all schemas as a ZIP file: [schemas.zip](/schemas.zip)

## Schema Categories

  <Card title="Common" icon="document">
    Browse [Common schemas](./common/)
  </Card>
  <Card title="Entity" icon="document">
    Browse [Entity schemas](./entity/)
  </Card>
  <Card title="Model" icon="document">
    Browse [Model schemas](./model/)
  </Card>
  <Card title="Processing" icon="document">
    Browse [Processing schemas](./processing/)
  </Card>
  <Card title="Search" icon="document">
    Browse [Search schemas](./search/)
  </Card>

## Using JSON Schemas

JSON schemas define the structure and validation rules for data in the Cyoda platform. Each schema includes:

- **Property definitions** with types and descriptions
- **Required fields** clearly marked
- **Validation rules** for data integrity
- **References** to related schemas

Navigate to any category above to explore the available schemas.