Updated Readme

Sithira · Jun 30, 2018 · a8781b6 · a8781b6
1 parent 2e9da7c
commit a8781b6
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -39,4 +39,7 @@ adonis serve --dev
 adonis test
 ```
 
+### Angular 6 Client
+[Client for APMS-BackEnd](https://github.com/Sithira/APMS-Client)
+
 _AAF Assesment 2018 SHU - Sithira Munasinghe (27045236)_
diff --git a/app/Controllers/Http/ProjectController.js b/app/Controllers/Http/ProjectController.js
@@ -8,6 +8,7 @@ class ProjectController
 	/**
 	 * Get all the projects
 	 *
+	 *
 	 * @param request
 	 * @param response
 	 * @returns {Promise<*|{limit, strict, types}|Promise<any>>}

diff --git a/app/Models/User.js b/app/Models/User.js
@@ -4,7 +4,25 @@ const Hash = use('Hash'),
 	Model = use('Model'),
 	Team = use('App/Models/Team');
 
-
+/**
+ *  @swagger
+ *  definitions:
+ *    User:
+ *      type: object
+ *      properties:
+ *        id:
+ *          type: uint
+ *        username:
+ *          type: string
+ *        email:
+ *          type: string
+ *        password:
+ *          type: string
+ *      required:
+ *        - username
+ *        - email
+ *        - password
+ */
 class User extends Model
 {
 

diff --git a/config/swagger.js b/config/swagger.js
@@ -19,8 +19,8 @@ module.exports = {
     // security definition config
     securityDefinitions: {
         ApiKey: {
-            description: 'ApiKey description',
-            name: 'Authorization'
+            description: 'JWT Token',
+            name: 'Bearer '
         },
 
         // OAuth2 configuration
@@ -49,6 +49,6 @@ module.exports = {
     ],
 
     definitions: [
-        'docs/models/*.yml'
+
     ]
 };
diff --git a/docs/controllers/Project.yml b/docs/controllers/Project.yml
@@ -25,4 +25,4 @@
       200:
         description: users
         schema:
-          $ref: '#/definitions/Project'
+          $ref: '#/definition/Project.yml'
diff --git a/docs/controllers/User.js b/docs/controllers/User.js
@@ -0,0 +1,21 @@
+/**
+ * @swagger
+ * /users:
+ *   post:
+ *     description: Creates a user
+ *     produces:
+ *       - application/json
+ *     parameters:
+ *       - name: user
+ *         description: User object
+ *         in:  body
+ *         required: true
+ *         type: string
+ *         schema:
+ *           $ref: '#/definitions/NewUser'
+ *     responses:
+ *       200:
+ *         description: users
+ *         schema:
+ *           $ref: '#/definitions/User'
+ */