| ... | @@ -8,7 +8,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
... | @@ -8,7 +8,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
|
|
|
|
|
|
|
### create a group, POST /faction/create-group/{game's UUID}
|
|
### create a group, POST /faction/create-group/{game's UUID}
|
|
|
|
|
|
|
|
- Body must contain a GameGroup JSON-object as specified in `faction.dto.ts`:
|
|
- Body must contain a GameGroup JSON-object as specified in [`faction.dto.ts`](./dtos#gamegroupdto):
|
|
|
|
|
|
|
|
- Must be sent with authorization header containing a Bearer token
|
|
- Must be sent with authorization header containing a Bearer token
|
|
|
|
|
|
| ... | @@ -20,7 +20,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
... | @@ -20,7 +20,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
|
|
|
|
|
|
|
### join group, PUT /faction/join-group/{game's UUID}
|
|
### join group, PUT /faction/join-group/{game's UUID}
|
|
|
|
|
|
|
|
- Body must contain a JoinGameGroup JSON-object as specified in `faction.dto.ts`:
|
|
- Body must contain a JoinGameGroup JSON-object as specified in [`faction.dto.ts`](./dtos#joingamegroupdto):
|
|
|
|
|
|
|
|
- Must be sent with authorization header containing a Bearer token
|
|
- Must be sent with authorization header containing a Bearer token
|
|
|
|
|
|
| ... | @@ -30,7 +30,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
... | @@ -30,7 +30,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
|
|
|
|
|
|
|
### promote player, PUT /faction/promote/{game's UUID}
|
|
### promote player, PUT /faction/promote/{game's UUID}
|
|
|
|
|
|
|
|
- Body must contain a PromotePlayer JSON-object as specified in `faction.dto.ts`:
|
|
- Body must contain a PromotePlayer JSON-object as specified in [`faction.dto.ts`](./dtos#promoteplayerdto):
|
|
|
|
|
|
|
|
- Must be sent with authorization header containing a Bearer token
|
|
- Must be sent with authorization header containing a Bearer token
|
|
|
|
|
|
| ... | @@ -40,7 +40,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
... | @@ -40,7 +40,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
|
|
|
|
|
|
|
### join a faction, PUT /faction/join-faction/{game's UUID}
|
|
### join a faction, PUT /faction/join-faction/{game's UUID}
|
|
|
|
|
|
|
|
- Body must contain a JoinFaction JSON-object as specified in [`faction.dto.ts`](./dtos#JoinFactionDTO):
|
|
- Body must contain a JoinFaction JSON-object as specified in [`faction.dto.ts`](./dtos#joinfactiondto):
|
|
|
|
|
|
|
|
- Must be sent with authorization header containing a Bearer token
|
|
- Must be sent with authorization header containing a Bearer token
|
|
|
|
|
|
| ... | @@ -62,7 +62,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
... | @@ -62,7 +62,7 @@ Contains seven routes, which are all prefixed with url `faction`. |
|
|
|
|
|
|
|
Contains seven functions
|
|
Contains seven functions
|
|
|
|
|
|
|
|
### joinFaction(data: [JoinFactionDTO](./dtos#JoinFactionDTO))
|
|
### joinFaction(data: [JoinFactionDTO](./dtos#joinfactiondto))
|
|
|
|
|
|
|
|
- Throws an exception if the faction was not found
|
|
- Throws an exception if the faction was not found
|
|
|
|
|
|
| ... | @@ -82,7 +82,7 @@ Contains seven functions |
... | @@ -82,7 +82,7 @@ Contains seven functions |
|
|
|
|
|
|
|
- Updates the target person's role to the new one
|
|
- Updates the target person's role to the new one
|
|
|
|
|
|
|
|
### createGroup(data: [GameGroupDTO](./dtos#GameGroupDTO))
|
|
### createGroup(data: [GameGroupDTO](./dtos#gamegroupdto))
|
|
|
|
|
|
|
|
- Throws and exception if the player already belongs to a group
|
|
- Throws and exception if the player already belongs to a group
|
|
|
|
|
|
| ... | @@ -94,7 +94,7 @@ Contains seven functions |
... | @@ -94,7 +94,7 @@ Contains seven functions |
|
|
|
|
|
|
|
- Response contains an array of groups, with last one being a "no group" entry with players who are not part of any groups
|
|
- Response contains an array of groups, with last one being a "no group" entry with players who are not part of any groups
|
|
|
|
|
|
|
|
### joinGroup(data: [JoinGameGroupDTO](./dtos#JoinGameGroupDTO))
|
|
### joinGroup(data: [JoinGameGroupDTO](./dtos#joingamegroupdto))
|
|
|
|
|
|
|
|
- Updates the group row with new player's information
|
|
- Updates the group row with new player's information
|
|
|
|
|
|
| ... | |
... | |
| ... | | ... | |