test_suite_schema.json

{
  "id": "https://raw.githubusercontent.com/JSONScript/jsonscript-test/master/test_suite_schema.json",
  "$schema": "https://raw.githubusercontent.com/epoberezkin/ajv/master/lib/refs/json-schema-v5.json#",
  "description": "schema for the test suite of the JSONScript scripts",
  "definitions": {
    "nonEmptyString": {
      "id": "#nonEmptyString",
      "type": "string",
      "minLength": 1
    }
  },
  "type": "array",
  "minItems": 1,
  "items": {
    "description": "set of tests for one script or for one data instance",
    "type": "object",
    "required": [ "description", "tests" ],
    "oneOf": [
      {
        "description": "required 'script' can be in the set of tests or in the test, but not in both",
        "required": [ "script" ]
      },
      {
        "properties": {
          "tests": {
            "items": {
              "required": [ "script" ]
            }
          }
        }
      }
    ],
    "not": {
      "anyOf": [
        {
          "description": "optional 'data' can be in the set of tests or in the test, but not in both",
          "required": [ "data" ],
          "properties": {
            "tests": {
              "items": {
                "required": [ "data" ]
              }
            }
          }
        },
        {
          "description": "'only' and 'skip' cannot be used at the same time",
          "required": [ "only", "skip" ]
        }
      ]
    },
    "properties": {
      "description": { "$ref": "#nonEmptyString" },
      "only": { "type": "boolean" },
      "skip": { "type": "boolean" },
      "script": {
        "description": "JSONScript to test",
        "$ref": "http://www.jsonscript.org/schema/schema.json#"
      },
      "data": {
        "description": "data instance, can be any type"
      },
      "tests": {
        "type": "array",
        "minItems": 1,
        "items": {
          "description": "one test, should either have 'result' or 'error' property but not both",
          "type": "object",
          "required": [ "description" ],
          "oneOf": [
            { "required": [ "result" ] },
            { "required": [ "error" ] }
          ],
          "properties": {
            "description": { "$ref": "#nonEmptyString" },
            "only": { "type": "boolean" },
            "skip": { "type": "boolean" },
            "script": {
              "description": "JSONScript to test",
              "$ref": "http://www.jsonscript.org/schema/schema.json#"
            },
            "data": {
              "description": "data instance, can be any type"
            },
            "result": {
              "description": "the result of script evaluation with the data instance"
            },
            "error": {
              "description": "expected error message",
              "anyOf": [
                { "enum": [ true ] },
                { "$ref": "#nonEmptyString" }
              ]
            }
          }
        }
      }
    }
  }
}