Skip to content

Commit 59ede1a

Browse files
wkingwking
committed
schema: Move schema.json -> config-schema.json and similar
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]: #453 [2]: #481 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 79b26a1 commit 59ede1a

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎schema/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
## Overview
44

5-
This directory contains the [JSON Schema](http://json-schema.org/) for
6-
validating the `config.json` of this container runtime specification.
5+
This directory contains the [JSON Schema](http://json-schema.org/) for validating JSON covered by this specification.
76

87
The layout of the files is as follows:
9-
* [schema.json](schema.json) - the primary entrypoint for the whole schema document
10-
* [schema-linux.json](schema-linux.json) - this schema is for the Linux-specific sub-structure
11-
* [schema-solaris.json](schema-solaris.json) - this schema is for the Solaris-specific sub-structure
8+
9+
* [config-schema.json](config.json) - the primary entrypoint for the [configuration](../config.md) schema
10+
* [config-linux.json](config-linux.json) - the [Linux-specific configuration sub-structure](../config-linux.md)
11+
* [config-solaris.json](config-solaris.json) - the [Solaris-specific configuration sub-structure](../config-solaris.md)
1212
* [defs.json](defs.json) - definitions for general types
1313
* [defs-linux.json](defs-linux.json) - definitions for Linux-specific types
1414
* [validate.go](validate.go) - validation utility source code
1515

1616

1717
## Utility
1818

19-
There is also included a simple utility for facilitating validation of a
20-
`config.json`. To build it:
19+
There is also included a simple utility for facilitating validation.
20+
To build it:
2121

2222
```bash
2323
export GOPATH=`mktemp -d`
@@ -35,5 +35,5 @@ make validate
3535
Then use it like:
3636

3737
```bash
38-
./validate schema.json <yourpath>/config.json
38+
./validate config-schema.json <yourpath>/config.json
3939
```

schema/schema-linux.json renamed to schema/config-linux.json

File renamed without changes.

schema/schema.json renamed to schema/config-schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,10 @@
166166
}
167167
},
168168
"linux": {
169-
"$ref": "schema-linux.json#/linux"
169+
"$ref": "config-linux.json#/linux"
170170
},
171171
"solaris": {
172-
"$ref": "schema-solaris.json#/solaris"
172+
"$ref": "config-solaris.json#/solaris"
173173
}
174174
},
175175
"required": [

schema/schema-solaris.json renamed to schema/config-solaris.json

File renamed without changes.

0 commit comments

Comments
 (0)