Overview

This section provides complete schema references for Datafye descriptors. These are detailed, field-by-field documentation intended for developers who need precise specifications.

Descriptor Types

Datafye uses three types of descriptors to configure your infrastructure:

Data Descriptors

Complete schema reference for DataSpec — defines what market data your algo needs, including datasets, symbols, tick/aggregate schemas, and retention policies.

Algo Descriptors

Complete schema reference for AlgoSpec — defines your algo container, execution parameters, resource limits, and data bindings.

Broker Descriptors

Complete schema reference for BrokerSpec — defines broker connections, order routing, position management, and risk controls.

How to Use This Reference

Each descriptor reference includes:

• Complete schema — All fields with types and constraints

• Field descriptions — Purpose and behavior of each field

• Validation rules — Required fields, allowed values, and formats

• Examples — Working samples for common scenarios

• Related concepts — Links to narrative guides

Related Documentation

• Concept guides — For narrative explanations, see Deployment Descriptors

• Quickstart — For getting started quickly, see Choose Your Path

• CLI commands — For using descriptors with the CLI, see CLI Reference

Format Support

All descriptors support both YAML and JSON formats:

apiVersion: datafye.io/v1
kind: DataSpec
metadata:
  name: my-data
# ...

{
  "apiVersion": "datafye.io/v1",
  "kind": "DataSpec",
  "metadata": {
    "name": "my-data"
  }
}

Use whichever format you prefer — both are equivalent and fully supported by the Datafye CLI.