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

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]>
opencontainers · Jun 6, 2016 · 8f67a50 · 8f67a50
1 parent 35b17a2
commit 8f67a50
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/schema/README.md b/schema/README.md
@@ -9,6 +9,7 @@ The layout of the files is as follows:
 * [config-schema.json](config.json) - the primary entrypoint for the [configuration](../config.md) schema
 * [config-linux.json](config-linux.json) - the [Linux-specific configuration sub-structure](../config-linux.md)
 * [config-solaris.json](config-solaris.json) - the [Solaris-specific configuration sub-structure](../config-solaris.md)
+* [state-schema.json](state.json) - the primary entrypoint for the [state JSON](../runtime.md#state) schema
 * [defs.json](defs.json) - definitions for general types
 * [defs-linux.json](defs-linux.json) - definitions for Linux-specific types
 * [validate.go](validate.go) - validation utility source code

diff --git a/schema/state-schema.json b/schema/state-schema.json
@@ -0,0 +1,45 @@
+{
+    "description": "Open Container Runtime State Schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "id": "https://opencontainers.org/schema/state",
+    "type": "object",
+    "properties": {
+        "ociVersion": {
+            "id": "https://opencontainers.org/schema/runtime/state/ociVersion",
+            "$ref": "defs.json#/definitions/ociVersion"
+        },
+        "id": {
+            "id": "https://opencontainers.org/schema/runtime/state/id",
+            "description": "the container's ID",
+            "type": "string"
+        },
+        "status": {
+            "id": "https://opencontainers.org/schema/runtime/state/status",
+            "type": "string",
+            "enum": [
+                "created",
+                "running",
+                "stopped"
+            ]
+        },
+        "pid": {
+            "id": "https://opencontainers.org/schema/runtime/state/pid",
+            "type": "integer",
+            "minimum": 0
+        },
+        "bundlePath": {
+            "id": "https://opencontainers.org/schema/runtime/state/bundlePath",
+            "type": "string"
+        },
+        "annotations": {
+            "$ref": "defs.json#/definitions/annotations"
+        }
+    },
+    "required": [
+        "ociVersion",
+        "id",
+        "status",
+        "pid",
+        "bundlePath"
+    ]
+}