Update sample req/res for broadcast PGN push (#311)

Response format updated,
moves -> tags+moves | tags+error

doc/specs/examples/_index.yaml

@@ -33,3 +33,9 @@ opponentGoneFalse:
 
 gameStateResign:
   $ref: './gameStateResign.yaml'
+
+broadcastPgnPushRequest:
+  $ref: './broadcastPgnPushRequest.yaml'
+
+broadcastPgnPushResponse:
+  $ref: './broadcastPgnPushResponse.yaml'

doc/specs/examples/broadcastPgnPushRequest.yaml

@@ -0,0 +1,24 @@
+value: |
+  [White "Rasmus Svane"]
+  [Black "Rajat Makkar"]
+  [BlackElo "2453"]
+  [BlackTeam "France"]
+  [BlackTitle "FM"]
+  [WhiteTeam "Germany"]
+  [Result "1-0"]
+  [WhiteElo "2632"]
+  [WhiteTitle "GM"]
+  
+  1. d4 d5
+  
+  [White "Joseph Girel"]
+  [Black "Matthias Bluebaum"]
+  [BlackElo "2658"]
+  [BlackTeam "Germany"]
+  [BlackTitle "GM"]
+  [WhiteTeam "France"]
+  [Result "0-1"]
+  [WhiteElo "2484"]
+  [WhiteTitle "IM"]
+  
+  1. a8

doc/specs/examples/broadcastPgnPushResponse.yaml

@@ -0,0 +1,32 @@
+value: {
+ "games": [
+   {
+     "tags": {
+       "White": "Rasmus Svane",
+       "Black": "Rajat Makkar",
+       "BlackElo": "2453",
+       "BlackTeam": "France",
+       "BlackTitle": "FM",
+       "WhiteTeam": "Germany",
+       "Result": "1-0",
+       "WhiteElo": "2632",
+       "WhiteTitle": "GM"
+     },
+     "moves": 2
+   },
+   {
+     "tags": {
+       "White": "Joseph Girel",
+       "Black": "Matthias Bluebaum",
+       "BlackElo": "2658",
+       "BlackTeam": "Germany",
+       "BlackTitle": "GM",
+       "WhiteTeam": "France",
+       "Result": "0-1",
+       "WhiteElo": "2484",
+       "WhiteTitle": "IM"
+     },
+     "error": "No move found: Pawn a8"
+   }
+ ]
+}

doc/specs/schemas/BroadcastPgnPush.yaml

@@ -0,0 +1,18 @@
+type: object
+properties:
+  games:
+    type: array
+    item:
+      oneOf:
+        - type: object
+          properties:
+            tags:
+              type: object
+            moves:
+              type: integer
+        - type: object
+          properties:
+            tags:
+              type: object
+            error:
+              type: string

doc/specs/schemas/_index.yaml

@@ -258,3 +258,6 @@ ExternalEngineWork:
 
 Timeline:
   $ref: './Timeline.yaml'
+
+BroadcastPgnPush:
+  $ref: './BroadcastPgnPush.yaml'

doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-push.yaml

@@ -22,6 +22,9 @@ post:
       text/plain:
         schema:
           type: string
+        examples:
+          broadcastPgnPushRequest:
+            $ref: '../../examples/broadcastPgnPushRequest.yaml'
   responses:
     "200":
       description: The broadcast was successfully updated.
@@ -33,11 +36,10 @@ post:
       content:
         application/json:
           schema:
-            properties:
-              moves:
-                type: integer
-            example:
-              moves: 12
+            $ref: '../../schemas/BroadcastPgnPush.yaml'
+          examples:
+            broadcastPgnPushResponse:
+              $ref: '../../examples/broadcastPgnPushResponse.yaml'
     "400":
       description: There was a problem with the pushed PGN.
       headers: