artillery/core/lib/schemas/artillery_test_script.json

Flexible and powerful toolkit for load and functional testing

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Schema for Artillery test scripts",
  "type": "object",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "environments": {
          "type": "object"
        },
        "target": { "type": "string" },
        "phases": {
          "type": "array"
        },
        "payload": {
          "anyOf": [ {"type": "object"}, {"type": "array"}]
        },
        "defaults": {
          "type": "object"
        },
        "ensure": {
          "type": "object"
        },
        "mode": {
          "type": "string",
          "enum": [ "poisson", "uniform" ]
        },
        "tls": {
          "type": "object"
        }
      }
    },
    "before": {
      "type": "object",
      "properties": {
        "flow": {
          "type": "array",
          "items": {
            "type": "object"            
          }
        }
      },
      "required": ["flow"]
    },
    "scenarios": {
      "type": "array"
    }
  },
  "required": ["scenarios"]
}