schema/state.json: Add a JSON Schema for the state JSON #481

wking · 2016-06-01T22:56:42Z

Make it easy for folks to validate state JSON the same way they can
currently validate config.json.

This is spun off from #453, and I've left the config-oriented IDs
alone (with their /schema/bundle/… IDs) to avoid pulling in that
rejected adjustment.

vbatts · 2016-06-02T12:17:58Z

I know you've mentioned your opinion on the redundancy of 'schema' in the filename, but I'm holding to that. Even in the image spec, for multiple schemas, they are named config-schema.json, image-manifest-schema.json and manifest-list-schema.json

wking · 2016-06-02T13:46:32Z

On Thu, Jun 02, 2016 at 05:18:00AM -0700, Vincent Batts wrote:

I know you've mentioned your opinion on the redundancy of 'schema'
in the filename, but I'm holding to that. Even in the image spec,
for multiple schemas, they are named config-schema.json,
image-manifest-schema.json and manifest-list-schema.json

I don't see the point, but it's fine with me 1. Is that just for
entrypoint JSON, or do you also want config-linux-schema.json,
defs-schema.json, etc.?

vbatts · 2016-06-03T17:29:43Z

The defs* files are not schema particularly themselves. I'm fairly confident that it isn't just my own opinion of logical file naming, that the schema files to validate against, would actually have 'schema' in the name. All other files would be sourced as needed.

wking · 2016-06-03T18:20:11Z

On Fri, Jun 03, 2016 at 10:29:45AM -0700, Vincent Batts wrote:

The defs* files are not schema particularly themselves.

The current schema-linux.json is also not a stand-alone schema.

… the schema files to validate against, would actually have 'schema'
in the name.

That sounds like “only use -schema for entrypoint files” 1. I'll
reroll to use config-linux.json, config-solaris.json, config-schema.json,
defs-linux.json, defs.json, and state-schema.json.

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]: opencontainers#453 [2]: opencontainers#481 (comment) Signed-off-by: W. Trevor King <[email protected]>

wking · 2016-06-03T20:25:57Z

On Fri, Jun 03, 2016 at 11:20:05AM -0700, W. Trevor King wrote:

On Fri, Jun 03, 2016 at 10:29:45AM -0700, Vincent Batts wrote:

… the schema files to validate against, would actually have
'schema' in the name.

That sounds like “only use -schema for entrypoint files” [1]. I'll
reroll to use config-linux.json, config-solaris.json,
config-schema.json, defs-linux.json, defs.json, and
state-schema.json.

Rerolled with ef4c6b0 → b4bcddb, which also rebases onto master
(around #482) and makes a few schema/README.md changes to more generic
language.

vbatts · 2016-06-06T14:46:14Z

LGTM

vbatts · 2016-06-06T14:48:19Z

for reference, could provide a pastebin or gist to the state.json you were testing against?

wking · 2016-06-06T15:50:11Z

On Mon, Jun 06, 2016 at 07:48:21AM -0700, Vincent Batts wrote:

for reference, could provide a pastebin or gist to the state.json
you were testing against?

I was just using the spec's example 1, although it looks like I need
to reroll to pickup #484 (so don't merge this yet ;).

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]: opencontainers#453 [2]: opencontainers#481 (comment) Signed-off-by: W. Trevor King <[email protected]>

wking · 2016-06-06T17:00:20Z

On Mon, Jun 06, 2016 at 08:49:55AM -0700, W. Trevor King wrote:

… it looks like I need to reroll to pick up #484…

Rerolled with b4bcddb → 8f67a50.

crosbymichael · 2016-06-07T00:42:34Z

LGTM

vbatts · 2016-06-09T03:16:37Z

LGTM

vbatts · 2016-06-09T03:16:47Z

rebase please

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]: opencontainers#453 [2]: opencontainers#481 (comment) Signed-off-by: W. Trevor King <[email protected]>

So we can use it in the coming state-schema.json without duplication. While I'm touching it, I updated the spec title to match the project README's header. I also dropped the "id" because none of the other defs.json entries had an ID. Signed-off-by: W. Trevor King <[email protected]>

So we can use it in the coming state-schema.json without duplication. I dropped the "id" because none of the other defs.json entries had an ID. Signed-off-by: W. Trevor King <[email protected]>

The IDs namespace the fields within the OCI, with /runtime to select the opencontainers/runtime-spec project, and /state to select the state JSON within runtime-spec. Signed-off-by: W. Trevor King <[email protected]>

wking · 2016-06-09T03:43:58Z

On Wed, Jun 08, 2016 at 08:16:49PM -0700, Vincent Batts wrote:

rebase please

Rebased around #491 with 8f67a50 → 2a5986f.

vbatts · 2016-06-09T10:47:41Z

LGTM

dqminh · 2016-06-09T12:00:58Z

LGTM

This slipped through the rename in 2a5986f (schema/state-schema.json: Add a JSON Schema for the state JSON, 2016-06-01, opencontainers#481) and the first round of fixes in dfb85b1 (schema/README: Fix links to (config|state)-schema.json, 2016-06-13, opencontainers#498). Reported by hapnermw [1]. [1]: opencontainers#517 Signed-off-by: W. Trevor King <[email protected]>

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]: opencontainers#453 [2]: opencontainers#481 (comment) Signed-off-by: W. Trevor King <[email protected]>

This slipped through the rename in 2a5986f (schema/state-schema.json: Add a JSON Schema for the state JSON, 2016-06-01, opencontainers#481) and the first round of fixes in dfb85b1 (schema/README: Fix links to (config|state)-schema.json, 2016-06-13, opencontainers#498). Reported by hapnermw [1]. [1]: opencontainers#517 Signed-off-by: W. Trevor King <[email protected]>

wking force-pushed the state-schema branch 2 times, most recently from ef4c6b0 to d31a3bf Compare June 1, 2016 22:59

wking force-pushed the state-schema branch from d31a3bf to b4bcddb Compare June 3, 2016 20:14

wking force-pushed the state-schema branch from b4bcddb to 8f67a50 Compare June 6, 2016 16:59

wking added 4 commits June 8, 2016 20:43

schema/defs.json: Pull annotations over from config-schema.json

a3126aa

So we can use it in the coming state-schema.json without duplication. I dropped the "id" because none of the other defs.json entries had an ID. Signed-off-by: W. Trevor King <[email protected]>

schema/state-schema.json: Add a JSON Schema for the state JSON

2a5986f

The IDs namespace the fields within the OCI, with /runtime to select the opencontainers/runtime-spec project, and /state to select the state JSON within runtime-spec. Signed-off-by: W. Trevor King <[email protected]>

wking force-pushed the state-schema branch from 8f67a50 to 2a5986f Compare June 9, 2016 03:43

dqminh merged commit 2f0fa18 into opencontainers:master Jun 9, 2016

wking mentioned this pull request Jun 13, 2016

schema/README: Fix links to (config|state)-schema.json #498

Merged

wking deleted the state-schema branch June 17, 2016 03:14

wking mentioned this pull request Jul 18, 2016

The reference to "schema/schema.json" is bad #517

Closed

wking mentioned this pull request Jul 19, 2016

config: Update schema.json -> config-schema.json #519

Merged

wking mentioned this pull request Oct 31, 2016

image-layout: some schema opencontainers/image-spec#428

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

schema/state.json: Add a JSON Schema for the state JSON #481

schema/state.json: Add a JSON Schema for the state JSON #481

wking commented Jun 1, 2016

vbatts commented Jun 2, 2016

wking commented Jun 2, 2016

vbatts commented Jun 3, 2016

wking commented Jun 3, 2016

wking commented Jun 3, 2016

vbatts commented Jun 6, 2016 •

edited by caniszczyk

Loading

vbatts commented Jun 6, 2016

wking commented Jun 6, 2016

wking commented Jun 6, 2016

crosbymichael commented Jun 7, 2016 •

edited by caniszczyk

Loading

vbatts commented Jun 9, 2016 •

edited by caniszczyk

Loading

vbatts commented Jun 9, 2016

wking commented Jun 9, 2016

vbatts commented Jun 9, 2016 •

edited by caniszczyk

Loading

dqminh commented Jun 9, 2016 •

edited by caniszczyk

Loading

schema/state.json: Add a JSON Schema for the state JSON #481

schema/state.json: Add a JSON Schema for the state JSON #481

Conversation

wking commented Jun 1, 2016

vbatts commented Jun 2, 2016

wking commented Jun 2, 2016

vbatts commented Jun 3, 2016

wking commented Jun 3, 2016

wking commented Jun 3, 2016

vbatts commented Jun 6, 2016 • edited by caniszczyk Loading

vbatts commented Jun 6, 2016

wking commented Jun 6, 2016

wking commented Jun 6, 2016

crosbymichael commented Jun 7, 2016 • edited by caniszczyk Loading

vbatts commented Jun 9, 2016 • edited by caniszczyk Loading

vbatts commented Jun 9, 2016

wking commented Jun 9, 2016

vbatts commented Jun 9, 2016 • edited by caniszczyk Loading

dqminh commented Jun 9, 2016 • edited by caniszczyk Loading

vbatts commented Jun 6, 2016 •

edited by caniszczyk

Loading

crosbymichael commented Jun 7, 2016 •

edited by caniszczyk

Loading

vbatts commented Jun 9, 2016 •

edited by caniszczyk

Loading

vbatts commented Jun 9, 2016 •

edited by caniszczyk

Loading

dqminh commented Jun 9, 2016 •

edited by caniszczyk

Loading