Add new optional commentary endpoint.

Author: eldering

contest-api/check-api.sh

@@ -22,6 +22,7 @@ judgements
 runs
 clarifications
 awards
+commentary
 scoreboard
 '
 
@@ -30,6 +31,7 @@ scoreboard
 ENDPOINTS_OPTIONAL='
 team-members
 awards
+commentary
 '
 
 ENDPOINTS_TO_FAIL='

contest-api/json-schema/commentaries.json

@@ -0,0 +1,12 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"title": "CLICS Contest API: commentary",
+	"description": "JSON response of this API call",
+
+	"type": "array",
+	"uniqueItems": true,
+	"$ref": "common.json#/nonemptyarray",
+	"items": {
+		"$ref": "commentary.json#"
+	}
+}

contest-api/json-schema/commentary.json

@@ -0,0 +1,25 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"title": "CLICS Contest API - commentary",
+	"description": "Definition of a single commentary object",
+
+	"type": "object",
+	"properties": {
+		"id": { "$ref": "common.json#/identifier" },
+		"time": { "$ref": "common.json#/abstime" },
+		"contest_time": { "$ref": "common.json#/reltime" },
+		"message": { "type": "string" },
+		"team_ids": {
+			"type": "array",
+			"uniqueItems": true,
+			"items": { "$ref": "common.json#/identifier" }
+		},
+		"problem_ids": {
+			"type": "array",
+			"uniqueItems": true,
+			"items": { "$ref": "common.json#/identifier" }
+		}
+	},
+	"required": ["id", "time", "contest_time", "message", "team_ids", "problem_ids"],
+	"$ref": "common.json#/strictproperties"
+}

contest-api/json-schema/common.json

@@ -19,6 +19,7 @@
 			"runs",
 			"clarifications",
 			"awards",
+			"commentary",
 			"scoreboard",
 			"event-feed"
 		]

contest-api/json-schema/event-feed.json

@@ -28,7 +28,8 @@
 						{ "$ref": "judgement.json#" },
 						{ "$ref": "run.json#" },
 						{ "$ref": "clarification.json#" },
-						{ "$ref": "award.json#" }
+						{ "$ref": "award.json#" },
+						{ "$ref": "commentary.json#" }
 					]
 				}
 			}