Topology Schema Reference#

DPS uses JSON schemas to validate topology definitions and ensure data consistency. These schemas are based on the DMTF Redfish specification with DPS-specific extensions.

These pages are generated from the schema files in the dcpower repository. Do not edit them by hand; edit scripts/generate-schema-pages.sh instead.

Available Schemas#

Usage#

These schemas are used for:

  1. Validation - Both dpsctl and dps-server validate topology files against these schemas

  2. Development - Use as reference when creating topology definitions

  3. Tooling - IDE integration for JSON validation and autocompletion

Schema Validation#

To validate your topology files against these schemas:

# Using dpsctl (recommended)
dpsctl topology validate topology.json

# Using an external JSON schema validator
npm install -g ajv-cli
ajv validate -s schemas/topology/topology.schema.json -d topology.json

Further Reading#