Merge pull request #63 from scrum-gang/docs

Docs
scrum-gang · Mar 25, 2019 · 91c396e · 91c396e
2 parents 877cd4d + 3cdafae
commit 91c396e
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # Authentication - Jobhub
 
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f193348b2004466ba69f53bec6f9de9a)](https://www.codacy.com/app/alexH2456/authentication?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=scrum-gang/authentication&amp;utm_campaign=Badge_Grade)
 [![Build Status](https://travis-ci.com/scrum-gang/authentication.svg?branch=master)](https://travis-ci.com/scrum-gang/authentication)
 [![Coverage Status](https://coveralls.io/repos/github/scrum-gang/authentication/badge.svg?branch=master)](https://coveralls.io/github/scrum-gang/authentication?branch=master)
 

diff --git a/doc/login.md b/doc/login.md
@@ -29,6 +29,16 @@ Returns session token for existing User on succesful login.
 
 ```json
 {
+    "user": {
+        "_id": "[user ID]",
+        "email": "[email]",
+        "password": "[hashed password]",
+        "type": "[user type]",
+        "verified": true,
+        "created_at": "[account creation date]",
+        "updated_at": "[last account update]",
+        "__v": 0
+    },
     "iat": "[Token issued at]",
     "exp": "[Token expiry]",
     "token": "[JWT token]"

diff --git a/doc/selfGet.md b/doc/selfGet.md
@@ -25,7 +25,10 @@ Returns corresponding user given JWT token.
     "email": "[User email]",
     "password": "[User password]",
     "type": "[User type]",
-    "verified": true
+    "verified": true,
+    "created_at": "[account creation date]",
+    "updated_at": "[last account update]",
+    "__v": 0
 }
 ```
 

diff --git a/src/index.html b/src/index.html
@@ -14,7 +14,7 @@
     </style>
 </head>
 <body>
-    <h1>👮 Welcome to the Jobhub Authentication Microservice 👮</h1>
+    <h1>👮 Welcome to the Jo🅱️hu🅱️ Authentication Microservice 👮</h1>
     <p>Please consult our <a href='https://github.com/scrum-gang/authentication'>repo</a> for endpoint information.</p>
 </body>
 </html>