[WIP][Swagger]Add swagger definition

- /auth/session/userkey
- User entity

2 files changed, 37 insertions, 0 deletions

diff --git a/src/api/endpoints/auth/session/generate.js b/src/api/endpoints/auth/session/generate.js
index 07ff8a8195..1390ae2909 100644
--- a/src/api/endpoints/auth/session/generate.js
+++ b/src/api/endpoints/auth/session/generate.js
@@ -15,6 +15,7 @@ import AuthSess from '../../../models/auth-session';
  *     parameters:
  *       -
  *         name: app_secret
+ *         description: App Secret
  *         in: formData
  *         required: true
  *         type: string
diff --git a/src/api/endpoints/auth/session/userkey.js b/src/api/endpoints/auth/session/userkey.js
index 2626e4ce39..918caa8f39 100644
--- a/src/api/endpoints/auth/session/userkey.js
+++ b/src/api/endpoints/auth/session/userkey.js
@@ -9,6 +9,42 @@ import Userkey from '../../../models/userkey';
 import serialize from '../../../serializers/user';
 
 /**
+ * @swagger
+ * /auth/session/userkey:
+ *   post:
+ *     summary: Get a userkey
+ *     parameters:
+ *       -
+ *         name: app_secret
+ *         description: App Secret
+ *         in: formData
+ *         required: true
+ *         type: string
+ *       -
+ *         name: token
+ *         description: API Token
+ *         in: formData
+ *         required: true
+ *         type: string
+ *     
+ *     responses:
+ *       200:
+ *         description: OK
+ *         schema:
+ *           type: object
+ *           properties:
+ *             userkey:
+ *               type: string
+ *               description: User Key
+ *             user:
+ *               $ref: "#/definitions/User"
+ *       400:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Generate a session
  *
  * @param {Object} params