runtime-spec/schema/README.md

JSON schema

Overview

This directory contains the JSON Schema for validating JSON covered by this specification.

The layout of the files is as follows:

• config-schema.json - the primary entrypoint for the configuration schema
• config-linux.json - the Linux-specific configuration sub-structure
• config-solaris.json - the Solaris-specific configuration sub-structure
• config-windows.json - the Windows-specific configuration sub-structure
• config-freebsd.json - the FreeBSD-specific configuration sub-structure
• state-schema.json - the primary entrypoint for the state JSON schema
• defs.json - definitions for general types
• defs-linux.json - definitions for Linux-specific types
• defs-windows.json - definitions for Windows-specific types
• validate.go - validation utility source code

Utility

There is also included a simple utility for facilitating validation. To build it:

go get github.com/xeipuuv/gojsonschema
go build ./validate.go

Or you can just use make command to create the utility:

make validate

Then use it like:

./validate config-schema.json <yourpath>/config.json

Or like:

./validate https://raw.githubusercontent.com/opencontainers/runtime-spec/<runtime-spec-version>/schema/config-schema.json <yourpath>/config.json