From 8de6b977005c39f8e02954d5a2fd78d3e6ec178c Mon Sep 17 00:00:00 2001
From: Kreusada <67752638+Kreusada@users.noreply.github.com>
Date: Thu, 2 Mar 2023 14:43:55 +0000
Subject: [PATCH] Add JSON Schema for Trivia Lists (#5565)

Co-authored-by: Jakub Kuczys <me@jacken.men>
---
 redbot/cogs/trivia/schema.py |  1 +
 schema/trivia.schema.json    | 61 ++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+)
 create mode 100644 schema/trivia.schema.json

diff --git a/redbot/cogs/trivia/schema.py b/redbot/cogs/trivia/schema.py
index 0abc7c5fb..19511a21c 100644
--- a/redbot/cogs/trivia/schema.py
+++ b/redbot/cogs/trivia/schema.py
@@ -36,6 +36,7 @@ ALWAYS_MATCH = Optional(Use(lambda x: x))
 MATCH_ALL_BUT_STR = Optional(Use(not_str))
 TRIVIA_LIST_SCHEMA = Schema(
     {
+        Optional("$schema"): And(str, error=_("{key} key must be a text value.")),
         Optional("AUTHOR"): And(str, error=_("{key} key must be a text value.")),
         Optional("CONFIG"): And(
             {
diff --git a/schema/trivia.schema.json b/schema/trivia.schema.json
new file mode 100644
index 000000000..e83bf2ec7
--- /dev/null
+++ b/schema/trivia.schema.json
@@ -0,0 +1,61 @@
+{
+  "$id": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/V3/develop/schema/trivia.schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Red-DiscordBot Trivia List file",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "AUTHOR": {
+      "type": "string",
+      "description": "Author of the Trivia list."
+    },
+    "CONFIG": {
+      "type": "object",
+      "description": "The configuration for a trivia session.",
+      "properties": {
+        "bot_plays": {
+          "type": "boolean",
+          "description": "Whether or not the bot gains points during the session."
+        },
+        "delay": {
+          "type": "number",
+          "description": "The maximum number of seconds permitted to answer a question, must be a positive number greater than or equal to 4.0.",
+          "minimum": 4.0
+        },
+        "max_score": {
+          "type": "integer",
+          "description": "Number of points required in order to win the trivia, must be a positive integer.",
+          "exclusiveMinimum": 0
+        },
+        "payout_multiplier": {
+          "type": "number",
+          "description": "The payout multiplier, must be a positive number or zero.",
+          "minimum": 0
+        },
+        "reveal_answer": {
+          "type": "boolean",
+          "description": "Whether or not to reveal the answer when the question times out."
+        },
+        "timeout": {
+          "type": "number",
+          "description": "Number of seconds that need to pass until trivia stops due to no response, must be a positive number greater than 0.0.",
+          "exclusiveMinimum": 0
+        },
+        "use_spoilers": {
+          "type": "boolean",
+          "description": "Whether to hide the answers in spoilers when revealing the question's answers."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": {
+    "type": "array",
+    "items": {
+      "type": "string"
+    }
+  }
+}