doc(Game): Fix doc for game.won. Closes #57

antoinezanardi · Nov 14, 2020 · 2e7fefc · 2e7fefc
1 parent 5981198
commit 2e7fefc
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # 📈 LIST OF CHANGES FOR WEREWOLVES ASSISTANT API
 
+## 0.7.0 (2020-11-??)
+
+### 📚 Documentation
+
+* [#57](https://github.com/antoinezanardi/werewolves-assistant-web/issues/57) - Fix doc for `game.won`.
+
+### 📦 Packages
+
+* `@sentry/node` updated to version `5.27.4`.
+* `mongoose` updated to version `5.10.14`.
+
+---
+
 ## 0.6.2 (2020-11-08)
 
 ### 🐛 Bug fixes

diff --git a/config/apidoc/apidoc.json b/config/apidoc/apidoc.json
@@ -1,6 +1,6 @@
 {
   "name": "\uD83D\uDC3A Werewolves Assistant API",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "Werewolves Assistant API provides over HTTP requests a way of manage Werewolves games in order to help the game master in his task.",
   "header": {
     "title": "Classes",

diff --git a/config/apidoc/header.md b/config/apidoc/header.md
@@ -35,8 +35,8 @@
 | status                                | String                                | Game's current status. (_See: [Codes - Game Statuses](#game-statuses)_)                                                                               |
 | history                               | [GameHistory[]](#game-history-class)  | Game's history. (_See: [Classes - Game History](#game-history-class)_)                                                                                |
 | **won***                              | Object                                | Winner(s) of the game when status is `done`.                                                                                                          |
-| &emsp;&emsp;by                        | String                                | Can be either a group or a role. (_Possibilites: `werewolves` or `villagers`_)                                                                        |
-| &emsp;&emsp;players                   | [Player[]](#player-class)             | List of player(s) who won. (_See: [Classes - Player](#player-class)_)                                                                                 |
+| &emsp;&emsp;by                        | String                                | Can be either a group or a role. (_Possibilities: `werewolves`, `villagers` or null if nobody won_)                                                   |
+| **&emsp;&emsp;players***              | [Player[]](#player-class)             | List of player(s) who won. (_See: [Classes - Player](#player-class)_)                                                                                 |
 | **review***                           | Object                                | Game master can attach a game review only if its status is set to `canceled` or `done`.                                                               |
 | &emsp;&emsp;rating                    | Number                                | Review's rating, from 0 to 5.                                                                                                                         |
 | **&emsp;&emsp;comment***              | String                                | Review's comment, from 1 to 500 characters long.                                                                                                      |

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "werewolwes-assistant-api",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "Back end for the werewolves assistant",
   "main": "app.js",
   "scripts": {
@@ -34,7 +34,7 @@
     "nodemon": "^2.0.6"
   },
   "dependencies": {
-    "@sentry/node": "^5.27.3",
+    "@sentry/node": "^5.27.4",
     "apidoc": "^0.25.0",
     "bcrypt": "^5.0.0",
     "body-parser": "^1.19.0",
@@ -47,7 +47,7 @@
     "jsonwebtoken": "^8.5.1",
     "migrate-mongo": "^8.1.4",
     "mongo-dot-notation": "^2.0.0",
-    "mongoose": "^5.10.13",
+    "mongoose": "^5.10.14",
     "passport": "^0.4.1",
     "passport-http": "^0.3.0",
     "passport-jwt": "^4.0.0",

diff --git a/src/routes/Game.js b/src/routes/Game.js
@@ -21,8 +21,8 @@ module.exports = app => {
      * @apiSuccess {String} status Game's current status. (_Possibilities: [Codes - Game Statuses](#game-statuses)_)
      * @apiSuccess {GameHistory[]} history Game's history. (_See: [Classes - Game History](#game-history-class)_)
      * @apiSuccess {Object} [won] Winners of the game when status is `done`.
-     * @apiSuccess {String={"werewolves", "villagers"}} won.by Can be either a group or a role. (_Possibilities: `werewolves` or `villagers`_)
-     * @apiSuccess {Player[]} won.players List of player(s) who won. (_See: [Classes - Player](#player-class)_)
+     * @apiSuccess {String={"werewolves", "villagers", null}} won.by Can be either a group or a role. (_Possibilities: `werewolves`, `villagers` or null if nobody won_)
+     * @apiSuccess {Player[]} [won.players] List of player(s) who won. (_See: [Classes - Player](#player-class)_)
      * @apiSuccess {Date} createdAt When the game was created.
      * @apiSuccess {Date} updatedAt When the game was updated.
      */

diff --git a/src/routes/index.js b/src/routes/index.js
@@ -12,7 +12,7 @@ module.exports = app => {
              * @apiSuccess {String} version API's version
              */
             app.route("/").get((req, res) => {
-                res.status(200).json({ name: "🐺 Werewolves Assistant API", version: "0.6.2" });
+                res.status(200).json({ name: "🐺 Werewolves Assistant API", version: "0.7.0" });
             });
             return;
         }