Add Jsondoc on actions

6 files changed, 29 insertions, 4 deletions

diff --git a/backend/src/main/java/org/luxons/sevenwonders/actions/ChooseNameAction.java b/backend/src/main/java/org/luxons/sevenwonders/actions/ChooseNameAction.java
index 9b0ed42b..fb5f7ec9 100644
--- a/backend/src/main/java/org/luxons/sevenwonders/actions/ChooseNameAction.java
+++ b/backend/src/main/java/org/luxons/sevenwonders/actions/ChooseNameAction.java
@@ -6,10 +6,9 @@ import javax.validation.constraints.Size;
 import org.jsondoc.core.annotation.ApiObject;
 import org.jsondoc.core.annotation.ApiObjectField;
 
-@ApiObject
-        (name = "Choose name action",
-         description = "The action to choose the player's name. This is the first action that should be called.",
-         group = "actions")
+@ApiObject(name = "Choose Name Action",
+           description = "The action to choose the player's name. This is the first action that should be called.",
+           group = "Actions")
 public class ChooseNameAction {
 
     @ApiObjectField(description = "The display name of the player. May contain spaces and special characters.",
diff --git a/backend/src/main/java/org/luxons/sevenwonders/actions/CreateGameAction.java b/backend/src/main/java/org/luxons/sevenwonders/actions/CreateGameAction.java
index 00a43971..ed96f18c 100644
--- a/backend/src/main/java/org/luxons/sevenwonders/actions/CreateGameAction.java
+++ b/backend/src/main/java/org/luxons/sevenwonders/actions/CreateGameAction.java
@@ -3,6 +3,11 @@ package org.luxons.sevenwonders.actions;
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Size;
 
+import org.jsondoc.core.annotation.ApiObject;
+
+@ApiObject(name = "Create Game Action",
+           description = "The action to create a game.",
+           group = "Actions")
 public class CreateGameAction {
 
     @NotNull
diff --git a/backend/src/main/java/org/luxons/sevenwonders/actions/JoinGameAction.java b/backend/src/main/java/org/luxons/sevenwonders/actions/JoinGameAction.java
index 82bff168..5c7a5f03 100644
--- a/backend/src/main/java/org/luxons/sevenwonders/actions/JoinGameAction.java
+++ b/backend/src/main/java/org/luxons/sevenwonders/actions/JoinGameAction.java
@@ -2,6 +2,11 @@ package org.luxons.sevenwonders.actions;
 
 import javax.validation.constraints.NotNull;
 
+import org.jsondoc.core.annotation.ApiObject;
+
+@ApiObject(name = "Join Game Action",
+           description = "The action to join a game.",
+           group = "Actions")
 public class JoinGameAction {
 
     @NotNull
diff --git a/backend/src/main/java/org/luxons/sevenwonders/actions/PrepareCardAction.java b/backend/src/main/java/org/luxons/sevenwonders/actions/PrepareCardAction.java
index 2fa857ad..0fc9f0ac 100644
--- a/backend/src/main/java/org/luxons/sevenwonders/actions/PrepareCardAction.java
+++ b/backend/src/main/java/org/luxons/sevenwonders/actions/PrepareCardAction.java
@@ -2,8 +2,12 @@ package org.luxons.sevenwonders.actions;
 
 import javax.validation.constraints.NotNull;
 
+import org.jsondoc.core.annotation.ApiObject;
 import org.luxons.sevenwonders.game.api.PlayerMove;
 
+@ApiObject(name = "Prepare Card Action",
+           description = "The action to prepare a card during a game.",
+           group = "Actions")
 public class PrepareCardAction {
 
     @NotNull
diff --git a/backend/src/main/java/org/luxons/sevenwonders/actions/ReorderPlayersAction.java b/backend/src/main/java/org/luxons/sevenwonders/actions/ReorderPlayersAction.java
index 803a71d8..dedca3fe 100644
--- a/backend/src/main/java/org/luxons/sevenwonders/actions/ReorderPlayersAction.java
+++ b/backend/src/main/java/org/luxons/sevenwonders/actions/ReorderPlayersAction.java
@@ -1,8 +1,15 @@
 package org.luxons.sevenwonders.actions;
 
 import java.util.List;
+
 import javax.validation.constraints.NotNull;
 
+import org.jsondoc.core.annotation.ApiObject;
+
+@ApiObject(name = "Reorder Players Action",
+           description = "The action to update the order of the players around the table. Can only be called in the "
+                   + "lobby by the owner of the game.",
+           group = "Actions")
 public class ReorderPlayersAction {
 
     @NotNull
diff --git a/backend/src/main/java/org/luxons/sevenwonders/actions/UpdateSettingsAction.java b/backend/src/main/java/org/luxons/sevenwonders/actions/UpdateSettingsAction.java
index 822a5a1c..e6a69e5b 100644
--- a/backend/src/main/java/org/luxons/sevenwonders/actions/UpdateSettingsAction.java
+++ b/backend/src/main/java/org/luxons/sevenwonders/actions/UpdateSettingsAction.java
@@ -2,8 +2,13 @@ package org.luxons.sevenwonders.actions;
 
 import javax.validation.constraints.NotNull;
 
+import org.jsondoc.core.annotation.ApiObject;
 import org.luxons.sevenwonders.game.api.CustomizableSettings;
 
+@ApiObject(name = "Update Settings Action",
+           description = "The action to update the settings of the game. Can only be called in the lobby by the owner"
+                   + " of the game.",
+           group = "Actions")
 public class UpdateSettingsAction {
 
     @NotNull