Просмотр исходного кода

fix swagger for access token api

reiji-h 1 год назад
Родитель
Сommit
b087573b0f
1 измененных файлов с 16 добавлено и 4 удалено
  1. 16 4
      apps/app/src/server/routes/apiv3/personal-setting.js

+ 16 - 4
apps/app/src/server/routes/apiv3/personal-setting.js

@@ -392,9 +392,9 @@ module.exports = (crowi) => {
    *           application/json:
    *           application/json:
    *             schema:
    *             schema:
    *               properties:
    *               properties:
-   *                 accessToken:
+   *                 accessTokens:
    *                   type: objet
    *                   type: objet
-   *                   description: expiredAt, description, scopes of access token
+   *                   description: array of access tokens
    */
    */
   router.get('/access-token', accessTokenParser, loginRequiredStrictly, addActivity, async(req, res) => {
   router.get('/access-token', accessTokenParser, loginRequiredStrictly, addActivity, async(req, res) => {
     const { user } = req;
     const { user } = req;
@@ -425,9 +425,21 @@ module.exports = (crowi) => {
    *             application/json:
    *             application/json:
    *               schema:
    *               schema:
    *                 properties:
    *                 properties:
+   *                   _id:
+   *                     type: string
+   *                     description: id of access token
    *                   token:
    *                   token:
    *                     type: string
    *                     type: string
    *                     description: access token
    *                     description: access token
+   *                   expiredAt:
+   *                     type: Date
+   *                     description: expired date
+   *                   description:
+   *                     type: string
+   *                     description: description of access token
+   *                   scope:
+   *                     type: string[]
+   *                     description: scope of access token
    */
    */
   router.post('/access-token', loginRequiredStrictly, addActivity, async(req, res) => {
   router.post('/access-token', loginRequiredStrictly, addActivity, async(req, res) => {
 
 
@@ -435,12 +447,12 @@ module.exports = (crowi) => {
     const { expiredAt, description, scope } = body;
     const { expiredAt, description, scope } = body;
 
 
     try {
     try {
-      const token = await AccessToken.generateToken(user, expiredAt, scope, description);
+      const tokenData = await AccessToken.generateToken(user, expiredAt, scope, description);
 
 
       const parameters = { action: SupportedAction.ACTION_USER_ACCESS_TOKEN_CREATE };
       const parameters = { action: SupportedAction.ACTION_USER_ACCESS_TOKEN_CREATE };
       activityEvent.emit('update', res.locals.activity._id, parameters);
       activityEvent.emit('update', res.locals.activity._id, parameters);
 
 
-      return res.apiv3(token);
+      return res.apiv3(tokenData);
     }
     }
     catch (err) {
     catch (err) {
       logger.error(err);
       logger.error(err);