Merge pull request #33 from Tosuke/swagger

Swagger

8 files changed, 269 insertions, 0 deletions

diff --git a/src/api/endpoints/app/create.js b/src/api/endpoints/app/create.js
index d83062c8e9..9ce98b197a 100644
--- a/src/api/endpoints/app/create.js
+++ b/src/api/endpoints/app/create.js
@@ -8,6 +8,59 @@ import App from '../../models/app';
 import serialize from '../../serializers/app';
 
 /**
+ * @swagger
+ * /app/create:
+ *   post:
+ *     summary: Create an application
+ *     parameters:
+ *       - $ref: "#/parameters/AccessToken"
+ *       -
+ *         name: name_id
+ *         description: Application unique name
+ *         in: formData
+ *         required: true
+ *         type: string
+ *       -
+ *         name: name
+ *         description: Application name
+ *         in: formData
+ *         required: true
+ *         type: string
+ *       -
+ *         name: description
+ *         description: Application description
+ *         in: formData
+ *         required: true
+ *         type: string
+ *       -
+ *         name: permission
+ *         description: Permissions that application has
+ *         in: formData
+ *         required: true
+ *         type: array
+ *         items:
+ *           type: string
+ *           collectionFormat: csv
+ *       -
+ *         name: callback_url
+ *         description: URL called back after authentication
+ *         in: formData
+ *         required: false
+ *         type: string
+ *       
+ *     responses:
+ *       200:
+ *         description: Created application's information
+ *         schema:
+ *           $ref: "#/definitions/Application"
+ *       
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Create an app
  *
  * @param {Object} params
diff --git a/src/api/endpoints/app/name_id/available.js b/src/api/endpoints/app/name_id/available.js
index 179925dce4..e101e0637f 100644
--- a/src/api/endpoints/app/name_id/available.js
+++ b/src/api/endpoints/app/name_id/available.js
@@ -6,6 +6,35 @@
 import App from '../../../models/app';
 
 /**
+ * @swagger
+ * /app/name_id/available:
+ *   post:
+ *     summary: Check available name_id on creation an application
+ *     parameters:
+ *       -
+ *         name: name_id
+ *         description: Application unique name
+ *         in: formData
+ *         required: true
+ *         type: string
+ *     
+ *     responses:
+ *       200:
+ *         description: Success
+ *         schema:
+ *           type: object
+ *           properties:
+ *             available:
+ *               description: Whether name_id is available
+ *               type: boolean
+ *         
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Check available name_id of app
  *
  * @param {Object} params
diff --git a/src/api/endpoints/app/show.js b/src/api/endpoints/app/show.js
index 8d12f9aeb1..2b651d53a9 100644
--- a/src/api/endpoints/app/show.js
+++ b/src/api/endpoints/app/show.js
@@ -8,6 +8,36 @@ import App from '../../models/app';
 import serialize from '../../serializers/app';
 
 /**
+ * @swagger
+ * /app/show:
+ *   post:
+ *     summary: Show an application's information
+ *     description: Require app_id or name_id
+ *     parameters:
+ *       -
+ *         name: app_id
+ *         description: Application ID
+ *         in: formData
+ *         type: string
+ *       -
+ *         name: name_id
+ *         description: Application unique name
+ *         in: formData
+ *         type: string
+ *         
+ *     responses:
+ *       200:
+ *         description: Success
+ *         schema:
+ *           $ref: "#/definitions/Application"
+ *           
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Show an app
  *
  * @param {Object} params
diff --git a/src/api/endpoints/auth/accept.js b/src/api/endpoints/auth/accept.js
index 110a0897df..131a0e5611 100644
--- a/src/api/endpoints/auth/accept.js
+++ b/src/api/endpoints/auth/accept.js
@@ -10,6 +10,29 @@ import AuthSess from '../../models/auth-session';
 import AccessToken from '../../models/access-token';
 
 /**
+ * @swagger
+ * /auth/accept:
+ *   post:
+ *     summary: Accept a session
+ *     parameters:
+ *       - $ref: "#/parameters/NativeToken"
+ *       - 
+ *         name: token
+ *         description: Session Token
+ *         in: formData
+ *         required: true
+ *         type: string
+ *     responses:
+ *       204:
+ *         description: OK
+ *       
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Accept
  *
  * @param {Object} params
diff --git a/src/api/endpoints/auth/session/generate.js b/src/api/endpoints/auth/session/generate.js
index bb49cf090d..f67209eee3 100644
--- a/src/api/endpoints/auth/session/generate.js
+++ b/src/api/endpoints/auth/session/generate.js
@@ -8,6 +8,37 @@ import App from '../../../models/app';
 import AuthSess from '../../../models/auth-session';
 
 /**
+ * @swagger
+ * /auth/session/generate:
+ *   post:
+ *     summary: Generate a session
+ *     parameters:
+ *       -
+ *         name: app_secret
+ *         description: App Secret
+ *         in: formData
+ *         required: true
+ *         type: string
+ *         
+ *     responses:
+ *       200:
+ *         description: OK
+ *         schema:
+ *           type: object
+ *           properties:
+ *             token:
+ *               type: string
+ *               description: Session Token
+ *             url:
+ *               type: string
+ *               description: Authentication form's URL
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Generate a session
  *
  * @param {Object} params
diff --git a/src/api/endpoints/auth/session/show.js b/src/api/endpoints/auth/session/show.js
index 67160c6993..e161d9e576 100644
--- a/src/api/endpoints/auth/session/show.js
+++ b/src/api/endpoints/auth/session/show.js
@@ -7,6 +7,46 @@ import AuthSess from '../../../models/auth-session';
 import serialize from '../../../serializers/auth-session';
 
 /**
+ * @swagger
+ * /auth/session/show:
+ *   post:
+ *     summary: Show a session information
+ *     parameters:
+ *       -
+ *         name: token
+ *         description: Session Token
+ *         in: formData
+ *         required: true
+ *         type: string
+ *         
+ *     responses:
+ *       200:
+ *         description: OK
+ *         schema: 
+ *           type: object
+ *           properties:
+ *             created_at:
+ *               type: string
+ *               format: date-time
+ *               description: Date and time of the session creation
+ *             app_id:
+ *               type: string
+ *               description: Application ID
+ *             token:
+ *               type: string
+ *               description: Session Token
+ *             user_id:
+ *               type: string
+ *               description: ID of user who create the session
+ *             app:
+ *               $ref: "#/definitions/Application"
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Show a session
  *
  * @param {Object} params
diff --git a/src/api/endpoints/auth/session/userkey.js b/src/api/endpoints/auth/session/userkey.js
index f85a720ea4..9905d7d844 100644
--- a/src/api/endpoints/auth/session/userkey.js
+++ b/src/api/endpoints/auth/session/userkey.js
@@ -9,6 +9,42 @@ import AccessToken from '../../../models/access-token';
 import serialize from '../../../serializers/user';
 
 /**
+ * @swagger
+ * /auth/session/userkey:
+ *   post:
+ *     summary: Get a access token(userkey)
+ *     parameters:
+ *       -
+ *         name: app_secret
+ *         description: App Secret
+ *         in: formData
+ *         required: true
+ *         type: string
+ *       -
+ *         name: token
+ *         description: Session Token
+ *         in: formData
+ *         required: true
+ *         type: string
+ *     
+ *     responses:
+ *       200:
+ *         description: OK
+ *         schema:
+ *           type: object
+ *           properties:
+ *             userkey:
+ *               type: string
+ *               description: Access Token
+ *             user:
+ *               $ref: "#/definitions/User"
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Generate a session
  *
  * @param {Object} params
diff --git a/src/api/endpoints/meta.js b/src/api/endpoints/meta.js
index acbe43a54d..88e7f64ddf 100644
--- a/src/api/endpoints/meta.js
+++ b/src/api/endpoints/meta.js
@@ -7,6 +7,33 @@ import prominence from 'prominence';
 import git from 'git-last-commit';
 
 /**
+ * @swagger
+ * /meta:
+ *   post:
+ *     summary: Show the misskey's information
+ *     responses:
+ *       200:
+ *         description: Success
+ *         schema:
+ *           type: object
+ *           properties:
+ *             maintainer:
+ *               description: maintainer's name
+ *               type: string
+ *             commit:
+ *               description: latest commit's hash
+ *               type: string
+ *             secure: 
+ *               description: whether the server supports secure protcols
+ *               type: boolean
+ *               
+ *       default:
+ *         description: Failed
+ *         schema:
+ *           $ref: "#/definitions/Error"
+ */
+
+/**
  * Show core info
  *
  * @param {Object} params