From aefa53bc65309869922d44509739bf2664cf50a5 Mon Sep 17 00:00:00 2001
From: Radu Nicolae <rnicolae04@gmail.com>
Date: Wed, 24 Apr 2024 15:09:22 +0200
Subject: Documentation update (#224)

---
 site/docs/documentation/Input/ScenarioSchema.md | 81 +++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 site/docs/documentation/Input/ScenarioSchema.md

(limited to 'site/docs/documentation/Input/ScenarioSchema.md')

diff --git a/site/docs/documentation/Input/ScenarioSchema.md b/site/docs/documentation/Input/ScenarioSchema.md
new file mode 100644
index 00000000..bd800fd7
--- /dev/null
+++ b/site/docs/documentation/Input/ScenarioSchema.md
@@ -0,0 +1,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",
+    ]
+}
+```
-- 
cgit v1.2.3