changeset 122:42d2367132df

Docs: add more info about database accounts
author David Demelier <markand@malikania.fr>
date Fri, 22 Sep 2017 13:02:56 +0200
parents 48f7e7277ab6
children fa7466083ba2
files docs/specs/db/account.md docs/specs/db/character.md docs/specs/db/spell.md
diffstat 3 files changed, 20 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/docs/specs/db/account.md	Fri Sep 22 12:56:55 2017 +0200
+++ b/docs/specs/db/account.md	Fri Sep 22 13:02:56 2017 +0200
@@ -14,6 +14,16 @@
 | lastname      | string                    |
 | createdate    | date (default to now)     |
 
+## Fields
+
+  - **id**: unique id,
+  - **login**: unique login,
+  - **password**: hashed password,
+  - **email**: user email,
+  - **firstname**: optional first name,
+  - **lastname**: optional last name,
+  - **createdate**: account creation date.
+
 ## Associations
 
 ````nohighlight
--- a/docs/specs/db/character.md	Fri Sep 22 12:56:55 2017 +0200
+++ b/docs/specs/db/character.md	Fri Sep 22 13:02:56 2017 +0200
@@ -8,11 +8,17 @@
 |---------------|---------------------------|
 | id            | big integer (primary key) |
 | account_id    | big integer               |
+| nickname      | string unique not null    |
+| classname     | string not null           |
 | level         | short uint                |
 | hp            | short uint                |
 
+## Fields
+
   - **id**: unique idenfitier,
   - **account_id**: references account.id,
+  - **nickname**: account unique nickname,
+  - **classname**: account class name,
   - **level**: current character level,
   - **hp**: current heal points.
 
--- a/docs/specs/db/spell.md	Fri Sep 22 12:56:55 2017 +0200
+++ b/docs/specs/db/spell.md	Fri Sep 22 13:02:56 2017 +0200
@@ -8,10 +8,12 @@
 |---------------|---------------------------|
 | id            | big integer (primary key) |
 | character_id  | big integer               |
+| classname     | string not null           |
 | level         | short int                 |
-| name          | string                    |
+
+## Fields
 
   - **id**: unique idenfitier,
   - **character_id**: references character.id,
+  - **classname**: the class name to create,
   - **level**: spell level,
-  - **name**: name of spell, to instanciate in the game.