From 1f528d3c9018d1325d5f19d43a1fd65aa89af5cb Mon Sep 17 00:00:00 2001
From: JensForstmann <19289807+JensForstmann@users.noreply.github.com>
Date: Wed, 3 Apr 2024 15:39:26 +0200
Subject: [PATCH] Add documentation that the `MATCH_END` event payload does
 include the team's advantage (if configured) in the fields `wonMapsTeamA` and
 `wonMapsTeamB`

---
 backend/swagger.json   | 6 ++++--
 common/types/events.ts | 2 ++
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/backend/swagger.json b/backend/swagger.json
index 44a6523..c3fd03b 100644
--- a/backend/swagger.json
+++ b/backend/swagger.json
@@ -1408,11 +1408,13 @@
 					},
 					"wonMapsTeamA": {
 						"type": "number",
-						"format": "double"
+						"format": "double",
+						"description": "number of maps team a has won including a their advantage (if given)"
 					},
 					"wonMapsTeamB": {
 						"type": "number",
-						"format": "double"
+						"format": "double",
+						"description": "number of maps team b has won including a their advantage (if given)"
 					},
 					"winnerTeam": {
 						"allOf": [
diff --git a/common/types/events.ts b/common/types/events.ts
index c3b9a89..1413aa6 100644
--- a/common/types/events.ts
+++ b/common/types/events.ts
@@ -63,7 +63,9 @@ export interface MapEndEvent extends BaseEvent {
 
 export interface MatchEndEvent extends BaseEvent {
 	type: 'MATCH_END';
+	/** number of maps team a has won including a their advantage (if given) */
 	wonMapsTeamA: number;
+	/** number of maps team b has won including a their advantage (if given) */
 	wonMapsTeamB: number;
 	/** winner of the match or null if it's a draw */
 	winnerTeam: ITeam | null;