summaryrefslogtreecommitdiff
path: root/site/docs/documentation/Input/ExperimentSchema.md
blob: 78ec55f717f03defce80148c3fe774261dcd241a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
Below is the schema for the Scenario JSON file. This schema can be used to validate a scenario file.
A scenario file can be validated using a JSON schema validator, such as https://www.jsonschemavalidator.net/.

```json
{
    "$schema": "OpenDC/Scenario",
    "$defs": {
        "topology": {
            "type": "object",
            "properties": {
                "pathToFile": {
                    "type": "string"
                }
            },
            "required": [
                "pathToFile"
            ]
        },
        "workload": {
            "type": "object",
            "properties": {
                "pathToFile": {
                    "type": "string"
                },
                "type": {
                    "type": "string"
                }
            },
            "required": [
                "pathToFile",
                "type"
            ]
        },
        "allocationPolicy": {
            "type": "object",
            "properties": {
                "policyType": {
                    "type": "string"
                }
            },
            "required": [
                "policyType"
            ]
        }
    },
    "properties": {
        "name": {
            "type": "string"
        },
        "topologies": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/topology"
            },
            "minItems": 1
        },
        "workloads": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/workload"
            },
            "minItems": 1
        },
        "allocationPolicies": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/allocationPolicy"
            },
            "minItems": 1
        },
        "runs": {
            "type": "integer"
        }
    },
    "required": [
        "topologies",
        "workloads",
        "allocationPolicies"
    ]
}
```