add json schema & validator for config

Signed-off-by: caozhuozi <[email protected]>

Author: caozhuozi

Makefile

@@ -0,0 +1,7 @@
+.PHONY: validate-examples
+validate-examples: ## validate examples in the specification markdown files
+	go test ./schema/example_test.go
+
+.PHONY: test
+test:
+	go test ./...

docs/config.md

@@ -107,7 +107,7 @@ The following terms are used in this section:
 
 Here is an example model artifact configuration JSON document:
 
-```json
+```json,title=Model%20Config%20JSON&mediatype=application/vnd.cnai.model.config.v1%2Bjson
 {
   "descriptor": {
     "createdAt": "2025-01-01T00:00:00Z",

go.mod

@@ -2,4 +2,8 @@ module github.com/CloudNativeAI/model-spec
 
 go 1.23.1
 
-require github.com/opencontainers/go-digest v1.0.0
+require (
+	github.com/opencontainers/go-digest v1.0.0
+	github.com/russross/blackfriday v1.6.0
+	github.com/santhosh-tekuri/jsonschema/v5 v5.3.1
+)

go.sum

@@ -1,2 +1,6 @@
 github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U=
 github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
+github.com/russross/blackfriday v1.6.0 h1:KqfZb0pUVN2lYqZUYRddxF4OR8ZMURnJIG5Y3VRLtww=
+github.com/russross/blackfriday v1.6.0/go.mod h1:ti0ldHuxg49ri4ksnFxlkCfN+hvslNlmVHqNRXXJNAY=
+github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 h1:lZUw3E0/J3roVtGQ+SCrUrg3ON6NgVqpn3+iol9aGu4=
+github.com/santhosh-tekuri/jsonschema/v5 v5.3.1/go.mod h1:uToXkOrWAZ6/Oc07xWQrPOhJotwFIyu2bBVN41fcDUY=

schema/config-schema.json

@@ -0,0 +1,117 @@
+{
+    "description": "Model Artifact Configuration Schema",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "$id": "https://github.com/CloudNativeAI/model-spec/config",
+    "type": "object",
+    "properties": {
+      "descriptor": {
+        "$ref": "#/$defs/ModelDescriptor"
+      },
+      "modelfs": {
+        "$ref": "#/$defs/ModelFS"
+      },
+      "config": {
+        "$ref": "#/$defs/ModelConfig"
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "descriptor",
+      "config",
+      "modelfs"
+    ],
+    "$defs": {
+      "ModelConfig": {
+        "type": "object",
+        "properties": {
+          "architecture": {
+            "type": "string"
+          },
+          "format": {
+            "type": "string"
+          },
+          "paramSize": {
+            "type": "string"
+          },
+          "precision": {
+            "type": "string"
+          },
+          "quantization": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      },
+      "ModelDescriptor": {
+        "type": "object",
+        "properties": {
+          "createdAt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "authors": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "family": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "docURL": {
+            "type": "string"
+          },
+          "sourceURL": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          },
+          "revision": {
+            "type": "string"
+          },
+          "vendor": {
+            "type": "string"
+          },
+          "licenses": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "title": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      },
+      "ModelFS": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["layers"]
+          },
+          "diff_ids": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "minItems": 1
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "diff_ids"
+        ]
+      }
+    }
+  }