59ede1a6ac
To make it clear that these schemas are for validating config.json (and not, for example, state JSON). I've left the IDs alone for now, because my PR adjusting those was rejected [1]. The rule for the -schema portion is "use it for entrypoint files" [2]. [1]: https://github.com/opencontainers/runtime-spec/pull/453 [2]: https://github.com/opencontainers/runtime-spec/pull/481#issuecomment-223641814 Signed-off-by: W. Trevor King <wking@tremily.us> |
||
---|---|---|
.. | ||
Makefile | ||
README.md | ||
config-linux.json | ||
config-schema.json | ||
config-solaris.json | ||
defs-linux.json | ||
defs.json | ||
validate.go |
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
- defs.json - definitions for general types
- defs-linux.json - definitions for Linux-specific types
- validate.go - validation utility source code
Utility
There is also included a simple utility for facilitating validation. To build it:
export GOPATH=`mktemp -d`
go get -d ./...
go build ./validate.go
rm -rf $GOPATH
Or you can just use make command to create the utility:
make validate
Then use it like:
./validate config-schema.json <yourpath>/config.json