Add documentation that the MATCH_END event payload does include the…

… team's advantage (if configured) in the fields `wonMapsTeamA` and `wonMapsTeamB`
JensForstmann · Apr 3, 2024 · 1f528d3 · 1f528d3
1 parent cd6de40
commit 1f528d3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git 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
@@ -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;