Skip to content
ReferenceNyl Resource Schemas

Nyl Resource Schemas

The resource catalog provides version-qualified references and schema downloads for every built-in Nyl resource.

Schemas are generated from Rust types, documentation comments, and example annotations. The same schemas supply editor validation and the documentation’s purpose descriptions, examples, and field references.

Terminal window
nyl schema config
nyl schema resource HelmChart --api-version k8s.nyl/v1
nyl schema resource DeploymentTarget
nyl schema gitops
nyl schema all --output-dir book/public/reference/schemas

The project schema describes nyl.toml. The GitOps aggregate covers shared GitRepository resources and Kubernetes GitOps resources. Individual resource schemas live beneath their API group and version; flat resource schema URLs resolve to their canonical schemas.

all also writes resources.json, the catalog manifest used for resource pages and navigation. Rust tests verify the committed artifacts; docs tests validate examples and schema rendering. Regenerate these artifacts whenever the Rust resource contracts or documentation change.