Merge pull request #399 from AllieJonsson/opening-explorer-models

Opening explorer models

doc/specs/schemas/OpeningExplorerJson.yaml

@@ -1,3 +1,43 @@
+type: object
+properties:
+  opening:
+    type: object
+    properties:
+      eco:
+        type: string
+      name:
+        type: string
+  white:
+    type: number
+  draws:
+    type: number
+  black:
+    type: number
+  moves:
+    type: array
+    items:
+      $ref: './OpeningExplorerMove.yaml'
+  topGames:
+    type: array
+    items:
+      $ref: './OpeningExplorerTopGame.yaml'
+  recentGames:
+    type: array
+    items:
+      type: object
+  history:
+    type: array
+    items:
+      type: object
+      properties:
+        month:
+          type: string
+        white:
+          type: number
+        draws:
+          type: number
+        black:
+          type: number
 example:
   {
     'opening': { 'eco': 'D10', 'name': 'Slav Defense: Exchange Variation' },

doc/specs/schemas/OpeningExplorerMove.yaml

@@ -0,0 +1,34 @@
+type: object
+properties:
+  uci:
+    type: string
+  san:
+    type: string
+  averageRating:
+    type: number
+  white:
+    type: number
+  draws:
+    type: number
+  black:
+    type: number
+  game:
+    oneOf:
+      - type: 'null'
+      - type: object
+        properties:
+          id: 
+            type: string
+          winner:
+            type: [string, 'null']
+            enum:
+              - white 
+              - black
+          white:
+            $ref: './OpeningExplorerPlayer.yaml'
+          black:
+            $ref: './OpeningExplorerPlayer.yaml'
+          year:
+            type: number
+          month:
+            type: string

doc/specs/schemas/OpeningExplorerPlayer.yaml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  name:
+    type: string
+  rating:
+    type: number

doc/specs/schemas/OpeningExplorerPlayerJson.yaml

@@ -1,3 +1,28 @@
+type: object
+properties: 
+  white:
+    type: number
+  draws:
+    type: number
+  black:
+    type: number
+  moves:
+    type: array
+    items:
+      $ref: './OpeningExplorerPlayerMove.yaml'
+  recentGames:
+    type: array
+    items:
+      $ref: './OpeningExplorerPlayerRecentGame.yaml'
+  opening:
+    type: object
+    properties:
+      eco:
+        type: string
+      name:
+        type: string
+  queuePosition:
+    type: number
 example:
   {
     'white': 359,

doc/specs/schemas/OpeningExplorerPlayerMove.yaml

@@ -0,0 +1,43 @@
+type: object
+properties:
+  uci:
+    type: string
+  san:
+    type: string
+  averageOpponentRating:
+    type: number
+  performance:
+    type: number
+  white:
+    type: number
+  draws:
+    type: number
+  black:
+    type: number
+  game:
+    oneOf:
+      - type: 'null'
+      - type: object
+        properties:
+          id: 
+            type: string
+          winner:
+            type: [string, 'null']
+            enum:
+              - white 
+              - black
+          speed:
+            $ref: './Speed.yaml'
+          mode:
+            type: string
+            enum:
+              - casual
+              - rated
+          white:
+            $ref: './OpeningExplorerPlayer.yaml'
+          black:
+            $ref: './OpeningExplorerPlayer.yaml'
+          year:
+            type: number
+          month:
+            type: string

doc/specs/schemas/OpeningExplorerPlayerRecentGame.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  uci:
+    type: string
+  id:
+    type: string
+  winner:
+    type: [string, 'null']
+  speed:
+    $ref: './Speed.yaml'
+  mode:
+    type: string
+    enum:
+      - casual
+      - rated
+  white:
+    $ref: './OpeningExplorerPlayer.yaml'
+  black:
+    $ref: './OpeningExplorerPlayer.yaml'
+  year:
+    type: number
+  month:
+    type: string

doc/specs/schemas/OpeningExplorerTopGame.yaml

@@ -0,0 +1,19 @@
+type: object
+properties:
+  uci:
+    type: string
+  id:
+    type: string
+  winner:
+    type: [string, 'null']
+    enum:
+      - white
+      - black
+  white:
+    $ref: './OpeningExplorerPlayer.yaml'
+  black:
+    $ref: './OpeningExplorerPlayer.yaml'
+  year:
+    type: number
+  month:
+    type: string