From 4dd5a443e5c6dc9248dd1e771063aa2071f521f5 Mon Sep 17 00:00:00 2001 From: Tosuke Date: Wed, 4 Jan 2017 15:04:54 +0900 Subject: [WIP][Swagger]Add swagger definition - /auth/session/userkey - User entity --- src/api/endpoints/auth/session/generate.js | 1 + src/api/endpoints/auth/session/userkey.js | 36 ++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) (limited to 'src/api/endpoints/auth') 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 @@ -8,6 +8,42 @@ import AuthSess from '../../../models/auth-session'; 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 * -- cgit v1.2.3-freya